/ cloudformation-templates / node_modules / aws-cdk / node_modules / aws-sdk / clients / iotsitewise.d.ts
iotsitewise.d.ts
1 import {Request} from '../lib/request'; 2 import {Response} from '../lib/response'; 3 import {AWSError} from '../lib/error'; 4 import {Service} from '../lib/service'; 5 import {WaiterConfiguration} from '../lib/service'; 6 import {ServiceConfigurationOptions} from '../lib/service'; 7 import {ConfigBase as Config} from '../lib/config-base'; 8 interface Blob {} 9 declare class IoTSiteWise extends Service { 10 /** 11 * Constructs a service object. This object has one method for each API operation. 12 */ 13 constructor(options?: IoTSiteWise.Types.ClientConfiguration) 14 config: Config & IoTSiteWise.Types.ClientConfiguration; 15 /** 16 * Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide. 17 */ 18 associateAssets(params: IoTSiteWise.Types.AssociateAssetsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 19 /** 20 * Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model. For more information, see Associating assets in the IoT SiteWise User Guide. 21 */ 22 associateAssets(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 23 /** 24 * Associates a group (batch) of assets with an IoT SiteWise Monitor project. 25 */ 26 batchAssociateProjectAssets(params: IoTSiteWise.Types.BatchAssociateProjectAssetsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.BatchAssociateProjectAssetsResponse) => void): Request<IoTSiteWise.Types.BatchAssociateProjectAssetsResponse, AWSError>; 27 /** 28 * Associates a group (batch) of assets with an IoT SiteWise Monitor project. 29 */ 30 batchAssociateProjectAssets(callback?: (err: AWSError, data: IoTSiteWise.Types.BatchAssociateProjectAssetsResponse) => void): Request<IoTSiteWise.Types.BatchAssociateProjectAssetsResponse, AWSError>; 31 /** 32 * Disassociates a group (batch) of assets from an IoT SiteWise Monitor project. 33 */ 34 batchDisassociateProjectAssets(params: IoTSiteWise.Types.BatchDisassociateProjectAssetsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.BatchDisassociateProjectAssetsResponse) => void): Request<IoTSiteWise.Types.BatchDisassociateProjectAssetsResponse, AWSError>; 35 /** 36 * Disassociates a group (batch) of assets from an IoT SiteWise Monitor project. 37 */ 38 batchDisassociateProjectAssets(callback?: (err: AWSError, data: IoTSiteWise.Types.BatchDisassociateProjectAssetsResponse) => void): Request<IoTSiteWise.Types.BatchDisassociateProjectAssetsResponse, AWSError>; 39 /** 40 * Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error. For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV. IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the IoT SiteWise User Guide. 41 */ 42 batchPutAssetPropertyValue(params: IoTSiteWise.Types.BatchPutAssetPropertyValueRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.BatchPutAssetPropertyValueResponse) => void): Request<IoTSiteWise.Types.BatchPutAssetPropertyValueResponse, AWSError>; 43 /** 44 * Sends a list of asset property values to IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting data using the API in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. With respect to Unix epoch time, IoT SiteWise accepts only TQVs that have a timestamp of no more than 7 days in the past and no more than 10 minutes in the future. IoT SiteWise rejects timestamps outside of the inclusive range of [-7 days, +10 minutes] and returns a TimestampOutOfRangeException error. For each asset property, IoT SiteWise overwrites TQVs with duplicate timestamps unless the newer TQV has a different quality. For example, if you store a TQV {T1, GOOD, V1}, then storing {T1, GOOD, V2} replaces the existing TQV. IoT SiteWise authorizes access to each BatchPutAssetPropertyValue entry individually. For more information, see BatchPutAssetPropertyValue authorization in the IoT SiteWise User Guide. 45 */ 46 batchPutAssetPropertyValue(callback?: (err: AWSError, data: IoTSiteWise.Types.BatchPutAssetPropertyValueResponse) => void): Request<IoTSiteWise.Types.BatchPutAssetPropertyValueResponse, AWSError>; 47 /** 48 * Creates an access policy that grants the specified identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource. 49 */ 50 createAccessPolicy(params: IoTSiteWise.Types.CreateAccessPolicyRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAccessPolicyResponse) => void): Request<IoTSiteWise.Types.CreateAccessPolicyResponse, AWSError>; 51 /** 52 * Creates an access policy that grants the specified identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user) access to the specified IoT SiteWise Monitor portal or project resource. 53 */ 54 createAccessPolicy(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAccessPolicyResponse) => void): Request<IoTSiteWise.Types.CreateAccessPolicyResponse, AWSError>; 55 /** 56 * Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide. 57 */ 58 createAsset(params: IoTSiteWise.Types.CreateAssetRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetResponse) => void): Request<IoTSiteWise.Types.CreateAssetResponse, AWSError>; 59 /** 60 * Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide. 61 */ 62 createAsset(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetResponse) => void): Request<IoTSiteWise.Types.CreateAssetResponse, AWSError>; 63 /** 64 * Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide. 65 */ 66 createAssetModel(params: IoTSiteWise.Types.CreateAssetModelRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetModelResponse) => void): Request<IoTSiteWise.Types.CreateAssetModelResponse, AWSError>; 67 /** 68 * Creates an asset model from specified property and hierarchy definitions. You create assets from asset models. With asset models, you can easily create assets of the same type that have standardized definitions. Each asset created from a model inherits the asset model's property and hierarchy definitions. For more information, see Defining asset models in the IoT SiteWise User Guide. 69 */ 70 createAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateAssetModelResponse) => void): Request<IoTSiteWise.Types.CreateAssetModelResponse, AWSError>; 71 /** 72 * Creates a dashboard in an IoT SiteWise Monitor project. 73 */ 74 createDashboard(params: IoTSiteWise.Types.CreateDashboardRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateDashboardResponse) => void): Request<IoTSiteWise.Types.CreateDashboardResponse, AWSError>; 75 /** 76 * Creates a dashboard in an IoT SiteWise Monitor project. 77 */ 78 createDashboard(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateDashboardResponse) => void): Request<IoTSiteWise.Types.CreateDashboardResponse, AWSError>; 79 /** 80 * Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide. 81 */ 82 createGateway(params: IoTSiteWise.Types.CreateGatewayRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateGatewayResponse) => void): Request<IoTSiteWise.Types.CreateGatewayResponse, AWSError>; 83 /** 84 * Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide. 85 */ 86 createGateway(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateGatewayResponse) => void): Request<IoTSiteWise.Types.CreateGatewayResponse, AWSError>; 87 /** 88 * Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses Amazon Web Services SSO or IAM to authenticate portal users and manage user permissions. Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide. 89 */ 90 createPortal(params: IoTSiteWise.Types.CreatePortalRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreatePortalResponse) => void): Request<IoTSiteWise.Types.CreatePortalResponse, AWSError>; 91 /** 92 * Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses Amazon Web Services SSO or IAM to authenticate portal users and manage user permissions. Before you can sign in to a new portal, you must add at least one identity to that portal. For more information, see Adding or removing portal administrators in the IoT SiteWise User Guide. 93 */ 94 createPortal(callback?: (err: AWSError, data: IoTSiteWise.Types.CreatePortalResponse) => void): Request<IoTSiteWise.Types.CreatePortalResponse, AWSError>; 95 /** 96 * Creates a project in the specified portal. 97 */ 98 createProject(params: IoTSiteWise.Types.CreateProjectRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.CreateProjectResponse) => void): Request<IoTSiteWise.Types.CreateProjectResponse, AWSError>; 99 /** 100 * Creates a project in the specified portal. 101 */ 102 createProject(callback?: (err: AWSError, data: IoTSiteWise.Types.CreateProjectResponse) => void): Request<IoTSiteWise.Types.CreateProjectResponse, AWSError>; 103 /** 104 * Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor resource. 105 */ 106 deleteAccessPolicy(params: IoTSiteWise.Types.DeleteAccessPolicyRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAccessPolicyResponse) => void): Request<IoTSiteWise.Types.DeleteAccessPolicyResponse, AWSError>; 107 /** 108 * Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource. You can use this operation to revoke access to an IoT SiteWise Monitor resource. 109 */ 110 deleteAccessPolicy(callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAccessPolicyResponse) => void): Request<IoTSiteWise.Types.DeleteAccessPolicyResponse, AWSError>; 111 /** 112 * Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide. You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets. 113 */ 114 deleteAsset(params: IoTSiteWise.Types.DeleteAssetRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAssetResponse) => void): Request<IoTSiteWise.Types.DeleteAssetResponse, AWSError>; 115 /** 116 * Deletes an asset. This action can't be undone. For more information, see Deleting assets and models in the IoT SiteWise User Guide. You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets. 117 */ 118 deleteAsset(callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAssetResponse) => void): Request<IoTSiteWise.Types.DeleteAssetResponse, AWSError>; 119 /** 120 * Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide. 121 */ 122 deleteAssetModel(params: IoTSiteWise.Types.DeleteAssetModelRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAssetModelResponse) => void): Request<IoTSiteWise.Types.DeleteAssetModelResponse, AWSError>; 123 /** 124 * Deletes an asset model. This action can't be undone. You must delete all assets created from an asset model before you can delete the model. Also, you can't delete an asset model if a parent asset model exists that contains a property formula expression that depends on the asset model that you want to delete. For more information, see Deleting assets and models in the IoT SiteWise User Guide. 125 */ 126 deleteAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteAssetModelResponse) => void): Request<IoTSiteWise.Types.DeleteAssetModelResponse, AWSError>; 127 /** 128 * Deletes a dashboard from IoT SiteWise Monitor. 129 */ 130 deleteDashboard(params: IoTSiteWise.Types.DeleteDashboardRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteDashboardResponse) => void): Request<IoTSiteWise.Types.DeleteDashboardResponse, AWSError>; 131 /** 132 * Deletes a dashboard from IoT SiteWise Monitor. 133 */ 134 deleteDashboard(callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteDashboardResponse) => void): Request<IoTSiteWise.Types.DeleteDashboardResponse, AWSError>; 135 /** 136 * Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system. 137 */ 138 deleteGateway(params: IoTSiteWise.Types.DeleteGatewayRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 139 /** 140 * Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system. 141 */ 142 deleteGateway(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 143 /** 144 * Deletes a portal from IoT SiteWise Monitor. 145 */ 146 deletePortal(params: IoTSiteWise.Types.DeletePortalRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DeletePortalResponse) => void): Request<IoTSiteWise.Types.DeletePortalResponse, AWSError>; 147 /** 148 * Deletes a portal from IoT SiteWise Monitor. 149 */ 150 deletePortal(callback?: (err: AWSError, data: IoTSiteWise.Types.DeletePortalResponse) => void): Request<IoTSiteWise.Types.DeletePortalResponse, AWSError>; 151 /** 152 * Deletes a project from IoT SiteWise Monitor. 153 */ 154 deleteProject(params: IoTSiteWise.Types.DeleteProjectRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteProjectResponse) => void): Request<IoTSiteWise.Types.DeleteProjectResponse, AWSError>; 155 /** 156 * Deletes a project from IoT SiteWise Monitor. 157 */ 158 deleteProject(callback?: (err: AWSError, data: IoTSiteWise.Types.DeleteProjectResponse) => void): Request<IoTSiteWise.Types.DeleteProjectResponse, AWSError>; 159 /** 160 * Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project. 161 */ 162 describeAccessPolicy(params: IoTSiteWise.Types.DescribeAccessPolicyRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAccessPolicyResponse) => void): Request<IoTSiteWise.Types.DescribeAccessPolicyResponse, AWSError>; 163 /** 164 * Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project. 165 */ 166 describeAccessPolicy(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAccessPolicyResponse) => void): Request<IoTSiteWise.Types.DescribeAccessPolicyResponse, AWSError>; 167 /** 168 * Retrieves information about an asset. 169 */ 170 describeAsset(params: IoTSiteWise.Types.DescribeAssetRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetResponse) => void): Request<IoTSiteWise.Types.DescribeAssetResponse, AWSError>; 171 /** 172 * Retrieves information about an asset. 173 */ 174 describeAsset(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetResponse) => void): Request<IoTSiteWise.Types.DescribeAssetResponse, AWSError>; 175 /** 176 * Retrieves information about an asset model. 177 */ 178 describeAssetModel(params: IoTSiteWise.Types.DescribeAssetModelRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetModelResponse) => void): Request<IoTSiteWise.Types.DescribeAssetModelResponse, AWSError>; 179 /** 180 * Retrieves information about an asset model. 181 */ 182 describeAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetModelResponse) => void): Request<IoTSiteWise.Types.DescribeAssetModelResponse, AWSError>; 183 /** 184 * Retrieves information about an asset property. When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value. This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue. 185 */ 186 describeAssetProperty(params: IoTSiteWise.Types.DescribeAssetPropertyRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetPropertyResponse) => void): Request<IoTSiteWise.Types.DescribeAssetPropertyResponse, AWSError>; 187 /** 188 * Retrieves information about an asset property. When you call this operation for an attribute property, this response includes the default attribute value that you define in the asset model. If you update the default value in the model, this operation's response includes the new default value. This operation doesn't return the value of the asset property. To get the value of an asset property, use GetAssetPropertyValue. 189 */ 190 describeAssetProperty(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetPropertyResponse) => void): Request<IoTSiteWise.Types.DescribeAssetPropertyResponse, AWSError>; 191 /** 192 * Retrieves information about a dashboard. 193 */ 194 describeDashboard(params: IoTSiteWise.Types.DescribeDashboardRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeDashboardResponse) => void): Request<IoTSiteWise.Types.DescribeDashboardResponse, AWSError>; 195 /** 196 * Retrieves information about a dashboard. 197 */ 198 describeDashboard(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeDashboardResponse) => void): Request<IoTSiteWise.Types.DescribeDashboardResponse, AWSError>; 199 /** 200 * Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, see Key management in the IoT SiteWise User Guide. 201 */ 202 describeDefaultEncryptionConfiguration(params: IoTSiteWise.Types.DescribeDefaultEncryptionConfigurationRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeDefaultEncryptionConfigurationResponse) => void): Request<IoTSiteWise.Types.DescribeDefaultEncryptionConfigurationResponse, AWSError>; 203 /** 204 * Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region. For more information, see Key management in the IoT SiteWise User Guide. 205 */ 206 describeDefaultEncryptionConfiguration(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeDefaultEncryptionConfigurationResponse) => void): Request<IoTSiteWise.Types.DescribeDefaultEncryptionConfigurationResponse, AWSError>; 207 /** 208 * Retrieves information about a gateway. 209 */ 210 describeGateway(params: IoTSiteWise.Types.DescribeGatewayRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeGatewayResponse) => void): Request<IoTSiteWise.Types.DescribeGatewayResponse, AWSError>; 211 /** 212 * Retrieves information about a gateway. 213 */ 214 describeGateway(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeGatewayResponse) => void): Request<IoTSiteWise.Types.DescribeGatewayResponse, AWSError>; 215 /** 216 * Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway. 217 */ 218 describeGatewayCapabilityConfiguration(params: IoTSiteWise.Types.DescribeGatewayCapabilityConfigurationRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeGatewayCapabilityConfigurationResponse) => void): Request<IoTSiteWise.Types.DescribeGatewayCapabilityConfigurationResponse, AWSError>; 219 /** 220 * Retrieves information about a gateway capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway. 221 */ 222 describeGatewayCapabilityConfiguration(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeGatewayCapabilityConfigurationResponse) => void): Request<IoTSiteWise.Types.DescribeGatewayCapabilityConfigurationResponse, AWSError>; 223 /** 224 * Retrieves the current IoT SiteWise logging options. 225 */ 226 describeLoggingOptions(params: IoTSiteWise.Types.DescribeLoggingOptionsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeLoggingOptionsResponse) => void): Request<IoTSiteWise.Types.DescribeLoggingOptionsResponse, AWSError>; 227 /** 228 * Retrieves the current IoT SiteWise logging options. 229 */ 230 describeLoggingOptions(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeLoggingOptionsResponse) => void): Request<IoTSiteWise.Types.DescribeLoggingOptionsResponse, AWSError>; 231 /** 232 * Retrieves information about a portal. 233 */ 234 describePortal(params: IoTSiteWise.Types.DescribePortalRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribePortalResponse) => void): Request<IoTSiteWise.Types.DescribePortalResponse, AWSError>; 235 /** 236 * Retrieves information about a portal. 237 */ 238 describePortal(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribePortalResponse) => void): Request<IoTSiteWise.Types.DescribePortalResponse, AWSError>; 239 /** 240 * Retrieves information about a project. 241 */ 242 describeProject(params: IoTSiteWise.Types.DescribeProjectRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeProjectResponse) => void): Request<IoTSiteWise.Types.DescribeProjectResponse, AWSError>; 243 /** 244 * Retrieves information about a project. 245 */ 246 describeProject(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeProjectResponse) => void): Request<IoTSiteWise.Types.DescribeProjectResponse, AWSError>; 247 /** 248 * Retrieves information about the storage configuration for IoT SiteWise. 249 */ 250 describeStorageConfiguration(params: IoTSiteWise.Types.DescribeStorageConfigurationRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeStorageConfigurationResponse) => void): Request<IoTSiteWise.Types.DescribeStorageConfigurationResponse, AWSError>; 251 /** 252 * Retrieves information about the storage configuration for IoT SiteWise. 253 */ 254 describeStorageConfiguration(callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeStorageConfigurationResponse) => void): Request<IoTSiteWise.Types.DescribeStorageConfigurationResponse, AWSError>; 255 /** 256 * Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model. 257 */ 258 disassociateAssets(params: IoTSiteWise.Types.DisassociateAssetsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 259 /** 260 * Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model. 261 */ 262 disassociateAssets(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 263 /** 264 * Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. 265 */ 266 getAssetPropertyAggregates(params: IoTSiteWise.Types.GetAssetPropertyAggregatesRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.GetAssetPropertyAggregatesResponse) => void): Request<IoTSiteWise.Types.GetAssetPropertyAggregatesResponse, AWSError>; 267 /** 268 * Gets aggregated values for an asset property. For more information, see Querying aggregates in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. 269 */ 270 getAssetPropertyAggregates(callback?: (err: AWSError, data: IoTSiteWise.Types.GetAssetPropertyAggregatesResponse) => void): Request<IoTSiteWise.Types.GetAssetPropertyAggregatesResponse, AWSError>; 271 /** 272 * Gets an asset property's current value. For more information, see Querying current values in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. 273 */ 274 getAssetPropertyValue(params: IoTSiteWise.Types.GetAssetPropertyValueRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.GetAssetPropertyValueResponse) => void): Request<IoTSiteWise.Types.GetAssetPropertyValueResponse, AWSError>; 275 /** 276 * Gets an asset property's current value. For more information, see Querying current values in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. 277 */ 278 getAssetPropertyValue(callback?: (err: AWSError, data: IoTSiteWise.Types.GetAssetPropertyValueResponse) => void): Request<IoTSiteWise.Types.GetAssetPropertyValueResponse, AWSError>; 279 /** 280 * Gets the history of an asset property's values. For more information, see Querying historical values in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. 281 */ 282 getAssetPropertyValueHistory(params: IoTSiteWise.Types.GetAssetPropertyValueHistoryRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.GetAssetPropertyValueHistoryResponse) => void): Request<IoTSiteWise.Types.GetAssetPropertyValueHistoryResponse, AWSError>; 283 /** 284 * Gets the history of an asset property's values. For more information, see Querying historical values in the IoT SiteWise User Guide. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. 285 */ 286 getAssetPropertyValueHistory(callback?: (err: AWSError, data: IoTSiteWise.Types.GetAssetPropertyValueHistoryResponse) => void): Request<IoTSiteWise.Types.GetAssetPropertyValueHistoryResponse, AWSError>; 287 /** 288 * Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data. For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. 289 */ 290 getInterpolatedAssetPropertyValues(params: IoTSiteWise.Types.GetInterpolatedAssetPropertyValuesRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.GetInterpolatedAssetPropertyValuesResponse) => void): Request<IoTSiteWise.Types.GetInterpolatedAssetPropertyValuesResponse, AWSError>; 291 /** 292 * Get interpolated values for an asset property for a specified time interval, during a period of time. If your time series is missing data points during the specified time interval, you can use interpolation to estimate the missing data. For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. To identify an asset property, you must specify one of the following: The assetId and propertyId of an asset property. A propertyAlias, which is a data stream alias (for example, /company/windfarm/3/turbine/7/temperature). To define an asset property's alias, see UpdateAssetProperty. 293 */ 294 getInterpolatedAssetPropertyValues(callback?: (err: AWSError, data: IoTSiteWise.Types.GetInterpolatedAssetPropertyValuesResponse) => void): Request<IoTSiteWise.Types.GetInterpolatedAssetPropertyValuesResponse, AWSError>; 295 /** 296 * Retrieves a paginated list of access policies for an identity (an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project). 297 */ 298 listAccessPolicies(params: IoTSiteWise.Types.ListAccessPoliciesRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListAccessPoliciesResponse) => void): Request<IoTSiteWise.Types.ListAccessPoliciesResponse, AWSError>; 299 /** 300 * Retrieves a paginated list of access policies for an identity (an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project). 301 */ 302 listAccessPolicies(callback?: (err: AWSError, data: IoTSiteWise.Types.ListAccessPoliciesResponse) => void): Request<IoTSiteWise.Types.ListAccessPoliciesResponse, AWSError>; 303 /** 304 * Retrieves a paginated list of summaries of all asset models. 305 */ 306 listAssetModels(params: IoTSiteWise.Types.ListAssetModelsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssetModelsResponse) => void): Request<IoTSiteWise.Types.ListAssetModelsResponse, AWSError>; 307 /** 308 * Retrieves a paginated list of summaries of all asset models. 309 */ 310 listAssetModels(callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssetModelsResponse) => void): Request<IoTSiteWise.Types.ListAssetModelsResponse, AWSError>; 311 /** 312 * Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root. 313 */ 314 listAssetRelationships(params: IoTSiteWise.Types.ListAssetRelationshipsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssetRelationshipsResponse) => void): Request<IoTSiteWise.Types.ListAssetRelationshipsResponse, AWSError>; 315 /** 316 * Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root. 317 */ 318 listAssetRelationships(callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssetRelationshipsResponse) => void): Request<IoTSiteWise.Types.ListAssetRelationshipsResponse, AWSError>; 319 /** 320 * Retrieves a paginated list of asset summaries. You can use this operation to do the following: List assets based on a specific asset model. List top-level assets. You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model. 321 */ 322 listAssets(params: IoTSiteWise.Types.ListAssetsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssetsResponse) => void): Request<IoTSiteWise.Types.ListAssetsResponse, AWSError>; 323 /** 324 * Retrieves a paginated list of asset summaries. You can use this operation to do the following: List assets based on a specific asset model. List top-level assets. You can't use this operation to list all assets. To retrieve summaries for all of your assets, use ListAssetModels to get all of your asset model IDs. Then, use ListAssets to get all assets for each asset model. 325 */ 326 listAssets(callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssetsResponse) => void): Request<IoTSiteWise.Types.ListAssetsResponse, AWSError>; 327 /** 328 * 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. 329 */ 330 listAssociatedAssets(params: IoTSiteWise.Types.ListAssociatedAssetsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssociatedAssetsResponse) => void): Request<IoTSiteWise.Types.ListAssociatedAssetsResponse, AWSError>; 331 /** 332 * 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. 333 */ 334 listAssociatedAssets(callback?: (err: AWSError, data: IoTSiteWise.Types.ListAssociatedAssetsResponse) => void): Request<IoTSiteWise.Types.ListAssociatedAssetsResponse, AWSError>; 335 /** 336 * Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project. 337 */ 338 listDashboards(params: IoTSiteWise.Types.ListDashboardsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListDashboardsResponse) => void): Request<IoTSiteWise.Types.ListDashboardsResponse, AWSError>; 339 /** 340 * Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project. 341 */ 342 listDashboards(callback?: (err: AWSError, data: IoTSiteWise.Types.ListDashboardsResponse) => void): Request<IoTSiteWise.Types.ListDashboardsResponse, AWSError>; 343 /** 344 * Retrieves a paginated list of gateways. 345 */ 346 listGateways(params: IoTSiteWise.Types.ListGatewaysRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListGatewaysResponse) => void): Request<IoTSiteWise.Types.ListGatewaysResponse, AWSError>; 347 /** 348 * Retrieves a paginated list of gateways. 349 */ 350 listGateways(callback?: (err: AWSError, data: IoTSiteWise.Types.ListGatewaysResponse) => void): Request<IoTSiteWise.Types.ListGatewaysResponse, AWSError>; 351 /** 352 * Retrieves a paginated list of IoT SiteWise Monitor portals. 353 */ 354 listPortals(params: IoTSiteWise.Types.ListPortalsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListPortalsResponse) => void): Request<IoTSiteWise.Types.ListPortalsResponse, AWSError>; 355 /** 356 * Retrieves a paginated list of IoT SiteWise Monitor portals. 357 */ 358 listPortals(callback?: (err: AWSError, data: IoTSiteWise.Types.ListPortalsResponse) => void): Request<IoTSiteWise.Types.ListPortalsResponse, AWSError>; 359 /** 360 * Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project. 361 */ 362 listProjectAssets(params: IoTSiteWise.Types.ListProjectAssetsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListProjectAssetsResponse) => void): Request<IoTSiteWise.Types.ListProjectAssetsResponse, AWSError>; 363 /** 364 * Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project. 365 */ 366 listProjectAssets(callback?: (err: AWSError, data: IoTSiteWise.Types.ListProjectAssetsResponse) => void): Request<IoTSiteWise.Types.ListProjectAssetsResponse, AWSError>; 367 /** 368 * Retrieves a paginated list of projects for an IoT SiteWise Monitor portal. 369 */ 370 listProjects(params: IoTSiteWise.Types.ListProjectsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListProjectsResponse) => void): Request<IoTSiteWise.Types.ListProjectsResponse, AWSError>; 371 /** 372 * Retrieves a paginated list of projects for an IoT SiteWise Monitor portal. 373 */ 374 listProjects(callback?: (err: AWSError, data: IoTSiteWise.Types.ListProjectsResponse) => void): Request<IoTSiteWise.Types.ListProjectsResponse, AWSError>; 375 /** 376 * Retrieves the list of tags for an IoT SiteWise resource. 377 */ 378 listTagsForResource(params: IoTSiteWise.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.ListTagsForResourceResponse) => void): Request<IoTSiteWise.Types.ListTagsForResourceResponse, AWSError>; 379 /** 380 * Retrieves the list of tags for an IoT SiteWise resource. 381 */ 382 listTagsForResource(callback?: (err: AWSError, data: IoTSiteWise.Types.ListTagsForResourceResponse) => void): Request<IoTSiteWise.Types.ListTagsForResourceResponse, AWSError>; 383 /** 384 * Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide. 385 */ 386 putDefaultEncryptionConfiguration(params: IoTSiteWise.Types.PutDefaultEncryptionConfigurationRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.PutDefaultEncryptionConfigurationResponse) => void): Request<IoTSiteWise.Types.PutDefaultEncryptionConfigurationResponse, AWSError>; 387 /** 388 * Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide. 389 */ 390 putDefaultEncryptionConfiguration(callback?: (err: AWSError, data: IoTSiteWise.Types.PutDefaultEncryptionConfigurationResponse) => void): Request<IoTSiteWise.Types.PutDefaultEncryptionConfigurationResponse, AWSError>; 391 /** 392 * Sets logging options for IoT SiteWise. 393 */ 394 putLoggingOptions(params: IoTSiteWise.Types.PutLoggingOptionsRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.PutLoggingOptionsResponse) => void): Request<IoTSiteWise.Types.PutLoggingOptionsResponse, AWSError>; 395 /** 396 * Sets logging options for IoT SiteWise. 397 */ 398 putLoggingOptions(callback?: (err: AWSError, data: IoTSiteWise.Types.PutLoggingOptionsResponse) => void): Request<IoTSiteWise.Types.PutLoggingOptionsResponse, AWSError>; 399 /** 400 * Configures storage settings for IoT SiteWise. 401 */ 402 putStorageConfiguration(params: IoTSiteWise.Types.PutStorageConfigurationRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.PutStorageConfigurationResponse) => void): Request<IoTSiteWise.Types.PutStorageConfigurationResponse, AWSError>; 403 /** 404 * Configures storage settings for IoT SiteWise. 405 */ 406 putStorageConfiguration(callback?: (err: AWSError, data: IoTSiteWise.Types.PutStorageConfigurationResponse) => void): Request<IoTSiteWise.Types.PutStorageConfigurationResponse, AWSError>; 407 /** 408 * Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value. 409 */ 410 tagResource(params: IoTSiteWise.Types.TagResourceRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.TagResourceResponse) => void): Request<IoTSiteWise.Types.TagResourceResponse, AWSError>; 411 /** 412 * Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value. 413 */ 414 tagResource(callback?: (err: AWSError, data: IoTSiteWise.Types.TagResourceResponse) => void): Request<IoTSiteWise.Types.TagResourceResponse, AWSError>; 415 /** 416 * Removes a tag from an IoT SiteWise resource. 417 */ 418 untagResource(params: IoTSiteWise.Types.UntagResourceRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UntagResourceResponse) => void): Request<IoTSiteWise.Types.UntagResourceResponse, AWSError>; 419 /** 420 * Removes a tag from an IoT SiteWise resource. 421 */ 422 untagResource(callback?: (err: AWSError, data: IoTSiteWise.Types.UntagResourceResponse) => void): Request<IoTSiteWise.Types.UntagResourceResponse, AWSError>; 423 /** 424 * Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource. 425 */ 426 updateAccessPolicy(params: IoTSiteWise.Types.UpdateAccessPolicyRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAccessPolicyResponse) => void): Request<IoTSiteWise.Types.UpdateAccessPolicyResponse, AWSError>; 427 /** 428 * Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource. 429 */ 430 updateAccessPolicy(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAccessPolicyResponse) => void): Request<IoTSiteWise.Types.UpdateAccessPolicyResponse, AWSError>; 431 /** 432 * Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide. 433 */ 434 updateAsset(params: IoTSiteWise.Types.UpdateAssetRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAssetResponse) => void): Request<IoTSiteWise.Types.UpdateAssetResponse, AWSError>; 435 /** 436 * Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide. 437 */ 438 updateAsset(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAssetResponse) => void): Request<IoTSiteWise.Types.UpdateAssetResponse, AWSError>; 439 /** 440 * Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide. This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel. If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property. 441 */ 442 updateAssetModel(params: IoTSiteWise.Types.UpdateAssetModelRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAssetModelResponse) => void): Request<IoTSiteWise.Types.UpdateAssetModelResponse, AWSError>; 443 /** 444 * Updates an asset model and all of the assets that were created from the model. Each asset created from the model inherits the updated asset model's property and hierarchy definitions. For more information, see Updating assets and models in the IoT SiteWise User Guide. This operation overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their IDs and definitions in the updated asset model payload. For more information, see DescribeAssetModel. If you remove a property from an asset model, IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property. 445 */ 446 updateAssetModel(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateAssetModelResponse) => void): Request<IoTSiteWise.Types.UpdateAssetModelResponse, AWSError>; 447 /** 448 * Updates an asset property's alias and notification state. This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty. 449 */ 450 updateAssetProperty(params: IoTSiteWise.Types.UpdateAssetPropertyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 451 /** 452 * Updates an asset property's alias and notification state. This operation overwrites the property's existing alias and notification state. To keep your existing property's alias or notification state, you must include the existing values in the UpdateAssetProperty request. For more information, see DescribeAssetProperty. 453 */ 454 updateAssetProperty(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 455 /** 456 * Updates an IoT SiteWise Monitor dashboard. 457 */ 458 updateDashboard(params: IoTSiteWise.Types.UpdateDashboardRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateDashboardResponse) => void): Request<IoTSiteWise.Types.UpdateDashboardResponse, AWSError>; 459 /** 460 * Updates an IoT SiteWise Monitor dashboard. 461 */ 462 updateDashboard(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateDashboardResponse) => void): Request<IoTSiteWise.Types.UpdateDashboardResponse, AWSError>; 463 /** 464 * Updates a gateway's name. 465 */ 466 updateGateway(params: IoTSiteWise.Types.UpdateGatewayRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 467 /** 468 * Updates a gateway's name. 469 */ 470 updateGateway(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>; 471 /** 472 * Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway. 473 */ 474 updateGatewayCapabilityConfiguration(params: IoTSiteWise.Types.UpdateGatewayCapabilityConfigurationRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateGatewayCapabilityConfigurationResponse) => void): Request<IoTSiteWise.Types.UpdateGatewayCapabilityConfigurationResponse, AWSError>; 475 /** 476 * Updates a gateway capability configuration or defines a new capability configuration. Each gateway capability defines data sources for a gateway. A capability configuration can contain multiple data source configurations. If you define OPC-UA sources for a gateway in the IoT SiteWise console, all of your OPC-UA sources are stored in one capability configuration. To list all capability configurations for a gateway, use DescribeGateway. 477 */ 478 updateGatewayCapabilityConfiguration(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateGatewayCapabilityConfigurationResponse) => void): Request<IoTSiteWise.Types.UpdateGatewayCapabilityConfigurationResponse, AWSError>; 479 /** 480 * Updates an IoT SiteWise Monitor portal. 481 */ 482 updatePortal(params: IoTSiteWise.Types.UpdatePortalRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UpdatePortalResponse) => void): Request<IoTSiteWise.Types.UpdatePortalResponse, AWSError>; 483 /** 484 * Updates an IoT SiteWise Monitor portal. 485 */ 486 updatePortal(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdatePortalResponse) => void): Request<IoTSiteWise.Types.UpdatePortalResponse, AWSError>; 487 /** 488 * Updates an IoT SiteWise Monitor project. 489 */ 490 updateProject(params: IoTSiteWise.Types.UpdateProjectRequest, callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateProjectResponse) => void): Request<IoTSiteWise.Types.UpdateProjectResponse, AWSError>; 491 /** 492 * Updates an IoT SiteWise Monitor project. 493 */ 494 updateProject(callback?: (err: AWSError, data: IoTSiteWise.Types.UpdateProjectResponse) => void): Request<IoTSiteWise.Types.UpdateProjectResponse, AWSError>; 495 /** 496 * Waits for the assetModelNotExists state by periodically calling the underlying IoTSiteWise.describeAssetModeloperation every 3 seconds (at most 20 times). 497 */ 498 waitFor(state: "assetModelNotExists", params: IoTSiteWise.Types.DescribeAssetModelRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetModelResponse) => void): Request<IoTSiteWise.Types.DescribeAssetModelResponse, AWSError>; 499 /** 500 * Waits for the assetModelNotExists state by periodically calling the underlying IoTSiteWise.describeAssetModeloperation every 3 seconds (at most 20 times). 501 */ 502 waitFor(state: "assetModelNotExists", callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetModelResponse) => void): Request<IoTSiteWise.Types.DescribeAssetModelResponse, AWSError>; 503 /** 504 * Waits for the assetModelActive state by periodically calling the underlying IoTSiteWise.describeAssetModeloperation every 3 seconds (at most 20 times). 505 */ 506 waitFor(state: "assetModelActive", params: IoTSiteWise.Types.DescribeAssetModelRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetModelResponse) => void): Request<IoTSiteWise.Types.DescribeAssetModelResponse, AWSError>; 507 /** 508 * Waits for the assetModelActive state by periodically calling the underlying IoTSiteWise.describeAssetModeloperation every 3 seconds (at most 20 times). 509 */ 510 waitFor(state: "assetModelActive", callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetModelResponse) => void): Request<IoTSiteWise.Types.DescribeAssetModelResponse, AWSError>; 511 /** 512 * Waits for the assetNotExists state by periodically calling the underlying IoTSiteWise.describeAssetoperation every 3 seconds (at most 20 times). 513 */ 514 waitFor(state: "assetNotExists", params: IoTSiteWise.Types.DescribeAssetRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetResponse) => void): Request<IoTSiteWise.Types.DescribeAssetResponse, AWSError>; 515 /** 516 * Waits for the assetNotExists state by periodically calling the underlying IoTSiteWise.describeAssetoperation every 3 seconds (at most 20 times). 517 */ 518 waitFor(state: "assetNotExists", callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetResponse) => void): Request<IoTSiteWise.Types.DescribeAssetResponse, AWSError>; 519 /** 520 * Waits for the assetActive state by periodically calling the underlying IoTSiteWise.describeAssetoperation every 3 seconds (at most 20 times). 521 */ 522 waitFor(state: "assetActive", params: IoTSiteWise.Types.DescribeAssetRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetResponse) => void): Request<IoTSiteWise.Types.DescribeAssetResponse, AWSError>; 523 /** 524 * Waits for the assetActive state by periodically calling the underlying IoTSiteWise.describeAssetoperation every 3 seconds (at most 20 times). 525 */ 526 waitFor(state: "assetActive", callback?: (err: AWSError, data: IoTSiteWise.Types.DescribeAssetResponse) => void): Request<IoTSiteWise.Types.DescribeAssetResponse, AWSError>; 527 /** 528 * Waits for the portalNotExists state by periodically calling the underlying IoTSiteWise.describePortaloperation every 3 seconds (at most 20 times). 529 */ 530 waitFor(state: "portalNotExists", params: IoTSiteWise.Types.DescribePortalRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribePortalResponse) => void): Request<IoTSiteWise.Types.DescribePortalResponse, AWSError>; 531 /** 532 * Waits for the portalNotExists state by periodically calling the underlying IoTSiteWise.describePortaloperation every 3 seconds (at most 20 times). 533 */ 534 waitFor(state: "portalNotExists", callback?: (err: AWSError, data: IoTSiteWise.Types.DescribePortalResponse) => void): Request<IoTSiteWise.Types.DescribePortalResponse, AWSError>; 535 /** 536 * Waits for the portalActive state by periodically calling the underlying IoTSiteWise.describePortaloperation every 3 seconds (at most 20 times). 537 */ 538 waitFor(state: "portalActive", params: IoTSiteWise.Types.DescribePortalRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: IoTSiteWise.Types.DescribePortalResponse) => void): Request<IoTSiteWise.Types.DescribePortalResponse, AWSError>; 539 /** 540 * Waits for the portalActive state by periodically calling the underlying IoTSiteWise.describePortaloperation every 3 seconds (at most 20 times). 541 */ 542 waitFor(state: "portalActive", callback?: (err: AWSError, data: IoTSiteWise.Types.DescribePortalResponse) => void): Request<IoTSiteWise.Types.DescribePortalResponse, AWSError>; 543 } 544 declare namespace IoTSiteWise { 545 export type ARN = string; 546 export type AccessPolicySummaries = AccessPolicySummary[]; 547 export interface AccessPolicySummary { 548 /** 549 * The ID of the access policy. 550 */ 551 id: ID; 552 /** 553 * The identity (an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user). 554 */ 555 identity: Identity; 556 /** 557 * The IoT SiteWise Monitor resource (a portal or project). 558 */ 559 resource: Resource; 560 /** 561 * The permissions for the access policy. Note that a project ADMINISTRATOR is also known as a project owner. 562 */ 563 permission: Permission; 564 /** 565 * The date the access policy was created, in Unix epoch time. 566 */ 567 creationDate?: Timestamp; 568 /** 569 * The date the access policy was last updated, in Unix epoch time. 570 */ 571 lastUpdateDate?: Timestamp; 572 } 573 export type AggregateType = "AVERAGE"|"COUNT"|"MAXIMUM"|"MINIMUM"|"SUM"|"STANDARD_DEVIATION"|string; 574 export type AggregateTypes = AggregateType[]; 575 export type AggregatedDoubleValue = number; 576 export interface AggregatedValue { 577 /** 578 * The date the aggregating computations occurred, in Unix epoch time. 579 */ 580 timestamp: Timestamp; 581 /** 582 * The quality of the aggregated data. 583 */ 584 quality?: Quality; 585 /** 586 * The value of the aggregates. 587 */ 588 value: Aggregates; 589 } 590 export type AggregatedValues = AggregatedValue[]; 591 export interface Aggregates { 592 /** 593 * The average (mean) value of the time series over a time interval window. 594 */ 595 average?: AggregatedDoubleValue; 596 /** 597 * The count of data points in the time series over a time interval window. 598 */ 599 count?: AggregatedDoubleValue; 600 /** 601 * The maximum value of the time series over a time interval window. 602 */ 603 maximum?: AggregatedDoubleValue; 604 /** 605 * The minimum value of the time series over a time interval window. 606 */ 607 minimum?: AggregatedDoubleValue; 608 /** 609 * The sum of the time series over a time interval window. 610 */ 611 sum?: AggregatedDoubleValue; 612 /** 613 * The standard deviation of the time series over a time interval window. 614 */ 615 standardDeviation?: AggregatedDoubleValue; 616 } 617 export interface Alarms { 618 /** 619 * The ARN of the IAM role that allows the alarm to perform actions and access Amazon Web Services resources and services, such as IoT Events. 620 */ 621 alarmRoleArn: ARN; 622 /** 623 * The ARN of the Lambda function that manages alarm notifications. For more information, see Managing alarm notifications in the IoT Events Developer Guide. 624 */ 625 notificationLambdaArn?: ARN; 626 } 627 export type AmazonResourceName = string; 628 export interface AssetCompositeModel { 629 /** 630 * The name of the composite model. 631 */ 632 name: Name; 633 /** 634 * The description of the composite model. 635 */ 636 description?: Description; 637 /** 638 * The type of the composite model. For alarm composite models, this type is AWS/ALARM. 639 */ 640 type: Name; 641 /** 642 * The asset properties that this composite model defines. 643 */ 644 properties: AssetProperties; 645 } 646 export type AssetCompositeModels = AssetCompositeModel[]; 647 export type AssetErrorCode = "INTERNAL_FAILURE"|string; 648 export interface AssetErrorDetails { 649 /** 650 * The ID of the asset. 651 */ 652 assetId: ID; 653 /** 654 * The error code. 655 */ 656 code: AssetErrorCode; 657 /** 658 * The error message. 659 */ 660 message: AssetErrorMessage; 661 } 662 export type AssetErrorMessage = string; 663 export type AssetHierarchies = AssetHierarchy[]; 664 export interface AssetHierarchy { 665 /** 666 * The ID of the hierarchy. This ID is a hierarchyId. 667 */ 668 id?: ID; 669 /** 670 * The hierarchy name provided in the CreateAssetModel or UpdateAssetModel API operation. 671 */ 672 name: Name; 673 } 674 export interface AssetHierarchyInfo { 675 /** 676 * The ID of the parent asset in this asset relationship. 677 */ 678 parentAssetId?: ID; 679 /** 680 * The ID of the child asset in this asset relationship. 681 */ 682 childAssetId?: ID; 683 } 684 export type AssetIDs = ID[]; 685 export interface AssetModelCompositeModel { 686 /** 687 * The name of the composite model. 688 */ 689 name: Name; 690 /** 691 * The description of the composite model. 692 */ 693 description?: Description; 694 /** 695 * The type of the composite model. For alarm composite models, this type is AWS/ALARM. 696 */ 697 type: Name; 698 /** 699 * The asset property definitions for this composite model. 700 */ 701 properties?: AssetModelProperties; 702 } 703 export interface AssetModelCompositeModelDefinition { 704 /** 705 * The name of the composite model. 706 */ 707 name: Name; 708 /** 709 * The description of the composite model. 710 */ 711 description?: Description; 712 /** 713 * The type of the composite model. For alarm composite models, this type is AWS/ALARM. 714 */ 715 type: Name; 716 /** 717 * The asset property definitions for this composite model. 718 */ 719 properties?: AssetModelPropertyDefinitions; 720 } 721 export type AssetModelCompositeModelDefinitions = AssetModelCompositeModelDefinition[]; 722 export type AssetModelCompositeModels = AssetModelCompositeModel[]; 723 export type AssetModelHierarchies = AssetModelHierarchy[]; 724 export interface AssetModelHierarchy { 725 /** 726 * The ID of the asset model hierarchy. This ID is a hierarchyId. 727 */ 728 id?: ID; 729 /** 730 * The name of the asset model hierarchy that you specify by using the CreateAssetModel or UpdateAssetModel API operation. 731 */ 732 name: Name; 733 /** 734 * The ID of the asset model. All assets in this hierarchy must be instances of the childAssetModelId asset model. 735 */ 736 childAssetModelId: ID; 737 } 738 export interface AssetModelHierarchyDefinition { 739 /** 740 * The name of the asset model hierarchy definition (as specified in the CreateAssetModel or UpdateAssetModel API operation). 741 */ 742 name: Name; 743 /** 744 * The ID of an asset model for this hierarchy. 745 */ 746 childAssetModelId: ID; 747 } 748 export type AssetModelHierarchyDefinitions = AssetModelHierarchyDefinition[]; 749 export type AssetModelProperties = AssetModelProperty[]; 750 export interface AssetModelProperty { 751 /** 752 * The ID of the asset model property. 753 */ 754 id?: ID; 755 /** 756 * The name of the asset model property. 757 */ 758 name: Name; 759 /** 760 * The data type of the asset model property. 761 */ 762 dataType: PropertyDataType; 763 /** 764 * The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type. 765 */ 766 dataTypeSpec?: Name; 767 /** 768 * The unit of the asset model property, such as Newtons or RPM. 769 */ 770 unit?: PropertyUnit; 771 /** 772 * The property type (see PropertyType). 773 */ 774 type: PropertyType; 775 } 776 export interface AssetModelPropertyDefinition { 777 /** 778 * The name of the property definition. 779 */ 780 name: Name; 781 /** 782 * The data type of the property definition. If you specify STRUCT, you must also specify dataTypeSpec to identify the type of the structure for this property. 783 */ 784 dataType: PropertyDataType; 785 /** 786 * The data type of the structure for this property. This parameter is required on properties that have the STRUCT data type. The options for this parameter depend on the type of the composite model in which you define this property. Use AWS/ALARM_STATE for alarm state in alarm composite models. 787 */ 788 dataTypeSpec?: Name; 789 /** 790 * The unit of the property definition, such as Newtons or RPM. 791 */ 792 unit?: PropertyUnit; 793 /** 794 * The property definition type (see PropertyType). You can only specify one type in a property definition. 795 */ 796 type: PropertyType; 797 } 798 export type AssetModelPropertyDefinitions = AssetModelPropertyDefinition[]; 799 export type AssetModelState = "CREATING"|"ACTIVE"|"UPDATING"|"PROPAGATING"|"DELETING"|"FAILED"|string; 800 export interface AssetModelStatus { 801 /** 802 * The current state of the asset model. 803 */ 804 state: AssetModelState; 805 /** 806 * Contains associated error information, if any. 807 */ 808 error?: ErrorDetails; 809 } 810 export type AssetModelSummaries = AssetModelSummary[]; 811 export interface AssetModelSummary { 812 /** 813 * The ID of the asset model (used with IoT SiteWise APIs). 814 */ 815 id: ID; 816 /** 817 * The ARN of the asset model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId} 818 */ 819 arn: ARN; 820 /** 821 * The name of the asset model. 822 */ 823 name: Name; 824 /** 825 * The asset model description. 826 */ 827 description: Description; 828 /** 829 * The date the asset model was created, in Unix epoch time. 830 */ 831 creationDate: Timestamp; 832 /** 833 * The date the asset model was last updated, in Unix epoch time. 834 */ 835 lastUpdateDate: Timestamp; 836 /** 837 * The current status of the asset model. 838 */ 839 status: AssetModelStatus; 840 } 841 export type AssetProperties = AssetProperty[]; 842 export interface AssetProperty { 843 /** 844 * The ID of the asset property. 845 */ 846 id: ID; 847 /** 848 * The name of the property. 849 */ 850 name: Name; 851 /** 852 * The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. 853 */ 854 alias?: PropertyAlias; 855 /** 856 * The asset property's notification topic and state. For more information, see UpdateAssetProperty. 857 */ 858 notification?: PropertyNotification; 859 /** 860 * The data type of the asset property. 861 */ 862 dataType: PropertyDataType; 863 /** 864 * The data type of the structure for this property. This parameter exists on properties that have the STRUCT data type. 865 */ 866 dataTypeSpec?: Name; 867 /** 868 * The unit (such as Newtons or RPM) of the asset property. 869 */ 870 unit?: PropertyUnit; 871 } 872 export type AssetPropertyAlias = string; 873 export interface AssetPropertyValue { 874 /** 875 * The value of the asset property (see Variant). 876 */ 877 value: Variant; 878 /** 879 * The timestamp of the asset property value. 880 */ 881 timestamp: TimeInNanos; 882 /** 883 * The quality of the asset property value. 884 */ 885 quality?: Quality; 886 } 887 export type AssetPropertyValueHistory = AssetPropertyValue[]; 888 export type AssetPropertyValues = AssetPropertyValue[]; 889 export type AssetRelationshipSummaries = AssetRelationshipSummary[]; 890 export interface AssetRelationshipSummary { 891 /** 892 * The assets that are related through an asset hierarchy. This object is present if the relationshipType is HIERARCHY. 893 */ 894 hierarchyInfo?: AssetHierarchyInfo; 895 /** 896 * The relationship type of the assets in this relationship. This value is one of the following: HIERARCHY – The assets are related through an asset hierarchy. If you specify this relationship type, this asset relationship includes the hierarchyInfo object. 897 */ 898 relationshipType: AssetRelationshipType; 899 } 900 export type AssetRelationshipType = "HIERARCHY"|string; 901 export type AssetState = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"FAILED"|string; 902 export interface AssetStatus { 903 /** 904 * The current status of the asset. 905 */ 906 state: AssetState; 907 /** 908 * Contains associated error information, if any. 909 */ 910 error?: ErrorDetails; 911 } 912 export type AssetSummaries = AssetSummary[]; 913 export interface AssetSummary { 914 /** 915 * The ID of the asset. 916 */ 917 id: ID; 918 /** 919 * The ARN of the asset, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} 920 */ 921 arn: ARN; 922 /** 923 * The name of the asset. 924 */ 925 name: Name; 926 /** 927 * The ID of the asset model used to create this asset. 928 */ 929 assetModelId: ID; 930 /** 931 * The date the asset was created, in Unix epoch time. 932 */ 933 creationDate: Timestamp; 934 /** 935 * The date the asset was last updated, in Unix epoch time. 936 */ 937 lastUpdateDate: Timestamp; 938 /** 939 * The current status of the asset. 940 */ 941 status: AssetStatus; 942 /** 943 * A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships. 944 */ 945 hierarchies: AssetHierarchies; 946 } 947 export interface AssociateAssetsRequest { 948 /** 949 * The ID of the parent asset. 950 */ 951 assetId: ID; 952 /** 953 * The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide. 954 */ 955 hierarchyId: ID; 956 /** 957 * The ID of the child asset to be associated. 958 */ 959 childAssetId: ID; 960 /** 961 * 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. 962 */ 963 clientToken?: ClientToken; 964 } 965 export type AssociatedAssetsSummaries = AssociatedAssetsSummary[]; 966 export interface AssociatedAssetsSummary { 967 /** 968 * The ID of the asset. 969 */ 970 id: ID; 971 /** 972 * The ARN of the asset, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} 973 */ 974 arn: ARN; 975 /** 976 * The name of the asset. 977 */ 978 name: Name; 979 /** 980 * The ID of the asset model used to create the asset. 981 */ 982 assetModelId: ID; 983 /** 984 * The date the asset was created, in Unix epoch time. 985 */ 986 creationDate: Timestamp; 987 /** 988 * The date the asset was last updated, in Unix epoch time. 989 */ 990 lastUpdateDate: Timestamp; 991 /** 992 * The current status of the asset. 993 */ 994 status: AssetStatus; 995 /** 996 * A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships. 997 */ 998 hierarchies: AssetHierarchies; 999 } 1000 export interface Attribute { 1001 /** 1002 * The default value of the asset model property attribute. All assets that you create from the asset model contain this attribute value. You can update an attribute's value after you create an asset. For more information, see Updating attribute values in the IoT SiteWise User Guide. 1003 */ 1004 defaultValue?: DefaultValue; 1005 } 1006 export type AuthMode = "IAM"|"SSO"|string; 1007 export type BatchAssociateProjectAssetsErrors = AssetErrorDetails[]; 1008 export interface BatchAssociateProjectAssetsRequest { 1009 /** 1010 * The ID of the project to which to associate the assets. 1011 */ 1012 projectId: ID; 1013 /** 1014 * The IDs of the assets to be associated to the project. 1015 */ 1016 assetIds: IDs; 1017 /** 1018 * 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. 1019 */ 1020 clientToken?: ClientToken; 1021 } 1022 export interface BatchAssociateProjectAssetsResponse { 1023 /** 1024 * A list of associated error information, if any. 1025 */ 1026 errors?: BatchAssociateProjectAssetsErrors; 1027 } 1028 export type BatchDisassociateProjectAssetsErrors = AssetErrorDetails[]; 1029 export interface BatchDisassociateProjectAssetsRequest { 1030 /** 1031 * The ID of the project from which to disassociate the assets. 1032 */ 1033 projectId: ID; 1034 /** 1035 * The IDs of the assets to be disassociated from the project. 1036 */ 1037 assetIds: IDs; 1038 /** 1039 * 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. 1040 */ 1041 clientToken?: ClientToken; 1042 } 1043 export interface BatchDisassociateProjectAssetsResponse { 1044 /** 1045 * A list of associated error information, if any. 1046 */ 1047 errors?: BatchDisassociateProjectAssetsErrors; 1048 } 1049 export interface BatchPutAssetPropertyError { 1050 /** 1051 * The error code. 1052 */ 1053 errorCode: BatchPutAssetPropertyValueErrorCode; 1054 /** 1055 * The associated error message. 1056 */ 1057 errorMessage: ErrorMessage; 1058 /** 1059 * A list of timestamps for each error, if any. 1060 */ 1061 timestamps: Timestamps; 1062 } 1063 export type BatchPutAssetPropertyErrorEntries = BatchPutAssetPropertyErrorEntry[]; 1064 export interface BatchPutAssetPropertyErrorEntry { 1065 /** 1066 * The ID of the failed entry. 1067 */ 1068 entryId: EntryId; 1069 /** 1070 * The list of update property value errors. 1071 */ 1072 errors: BatchPutAssetPropertyErrors; 1073 } 1074 export type BatchPutAssetPropertyErrors = BatchPutAssetPropertyError[]; 1075 export type BatchPutAssetPropertyValueErrorCode = "ResourceNotFoundException"|"InvalidRequestException"|"InternalFailureException"|"ServiceUnavailableException"|"ThrottlingException"|"LimitExceededException"|"ConflictingOperationException"|"TimestampOutOfRangeException"|"AccessDeniedException"|string; 1076 export interface BatchPutAssetPropertyValueRequest { 1077 /** 1078 * The list of asset property value entries for the batch put request. You can specify up to 10 entries per request. 1079 */ 1080 entries: PutAssetPropertyValueEntries; 1081 } 1082 export interface BatchPutAssetPropertyValueResponse { 1083 /** 1084 * A list of the errors (if any) associated with the batch put request. Each error entry contains the entryId of the entry that failed. 1085 */ 1086 errorEntries: BatchPutAssetPropertyErrorEntries; 1087 } 1088 export type CapabilityConfiguration = string; 1089 export type CapabilityNamespace = string; 1090 export type CapabilitySyncStatus = "IN_SYNC"|"OUT_OF_SYNC"|"SYNC_FAILED"|"UNKNOWN"|string; 1091 export type ClientToken = string; 1092 export interface CompositeModelProperty { 1093 /** 1094 * The name of the property. 1095 */ 1096 name: Name; 1097 /** 1098 * The type of the composite model that defines this property. 1099 */ 1100 type: Name; 1101 assetProperty: Property; 1102 } 1103 export type ComputeLocation = "EDGE"|"CLOUD"|string; 1104 export interface ConfigurationErrorDetails { 1105 /** 1106 * The error code. 1107 */ 1108 code: ErrorCode; 1109 /** 1110 * The error message. 1111 */ 1112 message: ErrorMessage; 1113 } 1114 export type ConfigurationState = "ACTIVE"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED"|string; 1115 export interface ConfigurationStatus { 1116 /** 1117 * The current state of the configuration. 1118 */ 1119 state: ConfigurationState; 1120 /** 1121 * Contains associated error information, if any. 1122 */ 1123 error?: ConfigurationErrorDetails; 1124 } 1125 export type CoreDeviceThingName = string; 1126 export interface CreateAccessPolicyRequest { 1127 /** 1128 * The identity for this access policy. Choose an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user. 1129 */ 1130 accessPolicyIdentity: Identity; 1131 /** 1132 * The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project. 1133 */ 1134 accessPolicyResource: Resource; 1135 /** 1136 * The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner. 1137 */ 1138 accessPolicyPermission: Permission; 1139 /** 1140 * 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. 1141 */ 1142 clientToken?: ClientToken; 1143 /** 1144 * A list of key-value pairs that contain metadata for the access policy. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide. 1145 */ 1146 tags?: TagMap; 1147 } 1148 export interface CreateAccessPolicyResponse { 1149 /** 1150 * The ID of the access policy. 1151 */ 1152 accessPolicyId: ID; 1153 /** 1154 * The ARN of the access policy, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId} 1155 */ 1156 accessPolicyArn: ARN; 1157 } 1158 export interface CreateAssetModelRequest { 1159 /** 1160 * A unique, friendly name for the asset model. 1161 */ 1162 assetModelName: Name; 1163 /** 1164 * A description for the asset model. 1165 */ 1166 assetModelDescription?: Description; 1167 /** 1168 * The property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide. You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide. 1169 */ 1170 assetModelProperties?: AssetModelPropertyDefinitions; 1171 /** 1172 * The hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide. You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide. 1173 */ 1174 assetModelHierarchies?: AssetModelHierarchyDefinitions; 1175 /** 1176 * The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model. 1177 */ 1178 assetModelCompositeModels?: AssetModelCompositeModelDefinitions; 1179 /** 1180 * 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. 1181 */ 1182 clientToken?: ClientToken; 1183 /** 1184 * 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. 1185 */ 1186 tags?: TagMap; 1187 } 1188 export interface CreateAssetModelResponse { 1189 /** 1190 * The ID of the asset model. You can use this ID when you call other IoT SiteWise APIs. 1191 */ 1192 assetModelId: ID; 1193 /** 1194 * The ARN of the asset model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId} 1195 */ 1196 assetModelArn: ARN; 1197 /** 1198 * The status of the asset model, which contains a state (CREATING after successfully calling this operation) and any error message. 1199 */ 1200 assetModelStatus: AssetModelStatus; 1201 } 1202 export interface CreateAssetRequest { 1203 /** 1204 * A unique, friendly name for the asset. 1205 */ 1206 assetName: Name; 1207 /** 1208 * The ID of the asset model from which to create the asset. 1209 */ 1210 assetModelId: ID; 1211 /** 1212 * 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. 1213 */ 1214 clientToken?: ClientToken; 1215 /** 1216 * A list of key-value pairs that contain metadata for the asset. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide. 1217 */ 1218 tags?: TagMap; 1219 } 1220 export interface CreateAssetResponse { 1221 /** 1222 * The ID of the asset. This ID uniquely identifies the asset within IoT SiteWise and can be used with other IoT SiteWise APIs. 1223 */ 1224 assetId: ID; 1225 /** 1226 * The ARN of the asset, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} 1227 */ 1228 assetArn: ARN; 1229 /** 1230 * The status of the asset, which contains a state (CREATING after successfully calling this operation) and any error message. 1231 */ 1232 assetStatus: AssetStatus; 1233 } 1234 export interface CreateDashboardRequest { 1235 /** 1236 * The ID of the project in which to create the dashboard. 1237 */ 1238 projectId: ID; 1239 /** 1240 * A friendly name for the dashboard. 1241 */ 1242 dashboardName: Name; 1243 /** 1244 * A description for the dashboard. 1245 */ 1246 dashboardDescription?: Description; 1247 /** 1248 * The dashboard definition specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide. 1249 */ 1250 dashboardDefinition: DashboardDefinition; 1251 /** 1252 * 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. 1253 */ 1254 clientToken?: ClientToken; 1255 /** 1256 * A list of key-value pairs that contain metadata for the dashboard. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide. 1257 */ 1258 tags?: TagMap; 1259 } 1260 export interface CreateDashboardResponse { 1261 /** 1262 * The ID of the dashboard. 1263 */ 1264 dashboardId: ID; 1265 /** 1266 * The ARN of the dashboard, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId} 1267 */ 1268 dashboardArn: ARN; 1269 } 1270 export interface CreateGatewayRequest { 1271 /** 1272 * A unique, friendly name for the gateway. 1273 */ 1274 gatewayName: Name; 1275 /** 1276 * The gateway's platform. You can only specify one platform in a gateway. 1277 */ 1278 gatewayPlatform: GatewayPlatform; 1279 /** 1280 * A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide. 1281 */ 1282 tags?: TagMap; 1283 } 1284 export interface CreateGatewayResponse { 1285 /** 1286 * The ID of the gateway device. You can use this ID when you call other IoT SiteWise APIs. 1287 */ 1288 gatewayId: ID; 1289 /** 1290 * The ARN of the gateway, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId} 1291 */ 1292 gatewayArn: ARN; 1293 } 1294 export interface CreatePortalRequest { 1295 /** 1296 * A friendly name for the portal. 1297 */ 1298 portalName: Name; 1299 /** 1300 * A description for the portal. 1301 */ 1302 portalDescription?: Description; 1303 /** 1304 * The Amazon Web Services administrator's contact email address. 1305 */ 1306 portalContactEmail: Email; 1307 /** 1308 * 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. 1309 */ 1310 clientToken?: ClientToken; 1311 /** 1312 * A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background. 1313 */ 1314 portalLogoImageFile?: ImageFile; 1315 /** 1316 * The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide. 1317 */ 1318 roleArn: ARN; 1319 /** 1320 * A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide. 1321 */ 1322 tags?: TagMap; 1323 /** 1324 * The service to use to authenticate users to the portal. Choose from the following options: SSO – The portal uses Amazon Web Services Single Sign On to authenticate users and manage user permissions. Before you can create a portal that uses Amazon Web Services SSO, you must enable Amazon Web Services SSO. For more information, see Enabling Amazon Web Services SSO in the IoT SiteWise User Guide. This option is only available in Amazon Web Services Regions other than the China Regions. IAM – The portal uses Identity and Access Management to authenticate users and manage user permissions. This option is only available in the China Regions. You can't change this value after you create a portal. Default: SSO 1325 */ 1326 portalAuthMode?: AuthMode; 1327 /** 1328 * The email address that sends alarm notifications. If you use the IoT Events managed Lambda function to manage your emails, you must verify the sender email address in Amazon SES. 1329 */ 1330 notificationSenderEmail?: Email; 1331 /** 1332 * Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide. 1333 */ 1334 alarms?: Alarms; 1335 } 1336 export interface CreatePortalResponse { 1337 /** 1338 * The ID of the created portal. 1339 */ 1340 portalId: ID; 1341 /** 1342 * The ARN of the portal, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} 1343 */ 1344 portalArn: ARN; 1345 /** 1346 * The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use Amazon Web Services SSO for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal. 1347 */ 1348 portalStartUrl: Url; 1349 /** 1350 * The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message. 1351 */ 1352 portalStatus: PortalStatus; 1353 /** 1354 * The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO. 1355 */ 1356 ssoApplicationId: SSOApplicationId; 1357 } 1358 export interface CreateProjectRequest { 1359 /** 1360 * The ID of the portal in which to create the project. 1361 */ 1362 portalId: ID; 1363 /** 1364 * A friendly name for the project. 1365 */ 1366 projectName: Name; 1367 /** 1368 * A description for the project. 1369 */ 1370 projectDescription?: Description; 1371 /** 1372 * 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. 1373 */ 1374 clientToken?: ClientToken; 1375 /** 1376 * A list of key-value pairs that contain metadata for the project. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide. 1377 */ 1378 tags?: TagMap; 1379 } 1380 export interface CreateProjectResponse { 1381 /** 1382 * The ID of the project. 1383 */ 1384 projectId: ID; 1385 /** 1386 * The ARN of the project, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId} 1387 */ 1388 projectArn: ARN; 1389 } 1390 export interface CustomerManagedS3Storage { 1391 /** 1392 * The ARN of the Amazon S3 object. For more information about how to find the ARN for an Amazon S3 object, see Amazon S3 resources in the Amazon Simple Storage Service User Guide. 1393 */ 1394 s3ResourceArn: ARN; 1395 /** 1396 * The ARN of the Identity and Access Management role that allows IoT SiteWise to send data to Amazon S3. 1397 */ 1398 roleArn: ARN; 1399 } 1400 export type DashboardDefinition = string; 1401 export type DashboardSummaries = DashboardSummary[]; 1402 export interface DashboardSummary { 1403 /** 1404 * The ID of the dashboard. 1405 */ 1406 id: ID; 1407 /** 1408 * The name of the dashboard 1409 */ 1410 name: Name; 1411 /** 1412 * The dashboard's description. 1413 */ 1414 description?: Description; 1415 /** 1416 * The date the dashboard was created, in Unix epoch time. 1417 */ 1418 creationDate?: Timestamp; 1419 /** 1420 * The date the dashboard was last updated, in Unix epoch time. 1421 */ 1422 lastUpdateDate?: Timestamp; 1423 } 1424 export type DefaultValue = string; 1425 export interface DeleteAccessPolicyRequest { 1426 /** 1427 * The ID of the access policy to be deleted. 1428 */ 1429 accessPolicyId: ID; 1430 /** 1431 * 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. 1432 */ 1433 clientToken?: ClientToken; 1434 } 1435 export interface DeleteAccessPolicyResponse { 1436 } 1437 export interface DeleteAssetModelRequest { 1438 /** 1439 * The ID of the asset model to delete. 1440 */ 1441 assetModelId: ID; 1442 /** 1443 * 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. 1444 */ 1445 clientToken?: ClientToken; 1446 } 1447 export interface DeleteAssetModelResponse { 1448 /** 1449 * The status of the asset model, which contains a state (DELETING after successfully calling this operation) and any error message. 1450 */ 1451 assetModelStatus: AssetModelStatus; 1452 } 1453 export interface DeleteAssetRequest { 1454 /** 1455 * The ID of the asset to delete. 1456 */ 1457 assetId: ID; 1458 /** 1459 * 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. 1460 */ 1461 clientToken?: ClientToken; 1462 } 1463 export interface DeleteAssetResponse { 1464 /** 1465 * The status of the asset, which contains a state (DELETING after successfully calling this operation) and any error message. 1466 */ 1467 assetStatus: AssetStatus; 1468 } 1469 export interface DeleteDashboardRequest { 1470 /** 1471 * The ID of the dashboard to delete. 1472 */ 1473 dashboardId: ID; 1474 /** 1475 * 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. 1476 */ 1477 clientToken?: ClientToken; 1478 } 1479 export interface DeleteDashboardResponse { 1480 } 1481 export interface DeleteGatewayRequest { 1482 /** 1483 * The ID of the gateway to delete. 1484 */ 1485 gatewayId: ID; 1486 } 1487 export interface DeletePortalRequest { 1488 /** 1489 * The ID of the portal to delete. 1490 */ 1491 portalId: ID; 1492 /** 1493 * 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. 1494 */ 1495 clientToken?: ClientToken; 1496 } 1497 export interface DeletePortalResponse { 1498 /** 1499 * The status of the portal, which contains a state (DELETING after successfully calling this operation) and any error message. 1500 */ 1501 portalStatus: PortalStatus; 1502 } 1503 export interface DeleteProjectRequest { 1504 /** 1505 * The ID of the project. 1506 */ 1507 projectId: ID; 1508 /** 1509 * 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. 1510 */ 1511 clientToken?: ClientToken; 1512 } 1513 export interface DeleteProjectResponse { 1514 } 1515 export interface DescribeAccessPolicyRequest { 1516 /** 1517 * The ID of the access policy. 1518 */ 1519 accessPolicyId: ID; 1520 } 1521 export interface DescribeAccessPolicyResponse { 1522 /** 1523 * The ID of the access policy. 1524 */ 1525 accessPolicyId: ID; 1526 /** 1527 * The ARN of the access policy, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId} 1528 */ 1529 accessPolicyArn: ARN; 1530 /** 1531 * The identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user) to which this access policy applies. 1532 */ 1533 accessPolicyIdentity: Identity; 1534 /** 1535 * The IoT SiteWise Monitor resource (portal or project) to which this access policy provides access. 1536 */ 1537 accessPolicyResource: Resource; 1538 /** 1539 * The access policy permission. Note that a project ADMINISTRATOR is also known as a project owner. 1540 */ 1541 accessPolicyPermission: Permission; 1542 /** 1543 * The date the access policy was created, in Unix epoch time. 1544 */ 1545 accessPolicyCreationDate: Timestamp; 1546 /** 1547 * The date the access policy was last updated, in Unix epoch time. 1548 */ 1549 accessPolicyLastUpdateDate: Timestamp; 1550 } 1551 export interface DescribeAssetModelRequest { 1552 /** 1553 * The ID of the asset model. 1554 */ 1555 assetModelId: ID; 1556 } 1557 export interface DescribeAssetModelResponse { 1558 /** 1559 * The ID of the asset model. 1560 */ 1561 assetModelId: ID; 1562 /** 1563 * The ARN of the asset model, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId} 1564 */ 1565 assetModelArn: ARN; 1566 /** 1567 * The name of the asset model. 1568 */ 1569 assetModelName: Name; 1570 /** 1571 * The asset model's description. 1572 */ 1573 assetModelDescription: Description; 1574 /** 1575 * The list of asset properties for the asset model. This object doesn't include properties that you define in composite models. You can find composite model properties in the assetModelCompositeModels object. 1576 */ 1577 assetModelProperties: AssetModelProperties; 1578 /** 1579 * A list of asset model hierarchies that each contain a childAssetModelId and a hierarchyId (named id). A hierarchy specifies allowed parent/child asset relationships for an asset model. 1580 */ 1581 assetModelHierarchies: AssetModelHierarchies; 1582 /** 1583 * The list of composite asset models for the asset model. 1584 */ 1585 assetModelCompositeModels?: AssetModelCompositeModels; 1586 /** 1587 * The date the asset model was created, in Unix epoch time. 1588 */ 1589 assetModelCreationDate: Timestamp; 1590 /** 1591 * The date the asset model was last updated, in Unix epoch time. 1592 */ 1593 assetModelLastUpdateDate: Timestamp; 1594 /** 1595 * The current status of the asset model, which contains a state and any error message. 1596 */ 1597 assetModelStatus: AssetModelStatus; 1598 } 1599 export interface DescribeAssetPropertyRequest { 1600 /** 1601 * The ID of the asset. 1602 */ 1603 assetId: ID; 1604 /** 1605 * The ID of the asset property. 1606 */ 1607 propertyId: ID; 1608 } 1609 export interface DescribeAssetPropertyResponse { 1610 /** 1611 * The ID of the asset. 1612 */ 1613 assetId: ID; 1614 /** 1615 * The name of the asset. 1616 */ 1617 assetName: Name; 1618 /** 1619 * The ID of the asset model. 1620 */ 1621 assetModelId: ID; 1622 /** 1623 * The asset property's definition, alias, and notification state. This response includes this object for normal asset properties. If you describe an asset property in a composite model, this response includes the asset property information in compositeModel. 1624 */ 1625 assetProperty?: Property; 1626 /** 1627 * The composite asset model that declares this asset property, if this asset property exists in a composite model. 1628 */ 1629 compositeModel?: CompositeModelProperty; 1630 } 1631 export interface DescribeAssetRequest { 1632 /** 1633 * The ID of the asset. 1634 */ 1635 assetId: ID; 1636 } 1637 export interface DescribeAssetResponse { 1638 /** 1639 * The ID of the asset. 1640 */ 1641 assetId: ID; 1642 /** 1643 * The ARN of the asset, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} 1644 */ 1645 assetArn: ARN; 1646 /** 1647 * The name of the asset. 1648 */ 1649 assetName: Name; 1650 /** 1651 * The ID of the asset model that was used to create the asset. 1652 */ 1653 assetModelId: ID; 1654 /** 1655 * The list of asset properties for the asset. This object doesn't include properties that you define in composite models. You can find composite model properties in the assetCompositeModels object. 1656 */ 1657 assetProperties: AssetProperties; 1658 /** 1659 * A list of asset hierarchies that each contain a hierarchyId. A hierarchy specifies allowed parent/child asset relationships. 1660 */ 1661 assetHierarchies: AssetHierarchies; 1662 /** 1663 * The composite models for the asset. 1664 */ 1665 assetCompositeModels?: AssetCompositeModels; 1666 /** 1667 * The date the asset was created, in Unix epoch time. 1668 */ 1669 assetCreationDate: Timestamp; 1670 /** 1671 * The date the asset was last updated, in Unix epoch time. 1672 */ 1673 assetLastUpdateDate: Timestamp; 1674 /** 1675 * The current status of the asset, which contains a state and any error message. 1676 */ 1677 assetStatus: AssetStatus; 1678 } 1679 export interface DescribeDashboardRequest { 1680 /** 1681 * The ID of the dashboard. 1682 */ 1683 dashboardId: ID; 1684 } 1685 export interface DescribeDashboardResponse { 1686 /** 1687 * The ID of the dashboard. 1688 */ 1689 dashboardId: ID; 1690 /** 1691 * The ARN of the dashboard, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId} 1692 */ 1693 dashboardArn: ARN; 1694 /** 1695 * The name of the dashboard. 1696 */ 1697 dashboardName: Name; 1698 /** 1699 * The ID of the project that the dashboard is in. 1700 */ 1701 projectId: ID; 1702 /** 1703 * The dashboard's description. 1704 */ 1705 dashboardDescription?: Description; 1706 /** 1707 * The dashboard's definition JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide. 1708 */ 1709 dashboardDefinition: DashboardDefinition; 1710 /** 1711 * The date the dashboard was created, in Unix epoch time. 1712 */ 1713 dashboardCreationDate: Timestamp; 1714 /** 1715 * The date the dashboard was last updated, in Unix epoch time. 1716 */ 1717 dashboardLastUpdateDate: Timestamp; 1718 } 1719 export interface DescribeDefaultEncryptionConfigurationRequest { 1720 } 1721 export interface DescribeDefaultEncryptionConfigurationResponse { 1722 /** 1723 * The type of encryption used for the encryption configuration. 1724 */ 1725 encryptionType: EncryptionType; 1726 /** 1727 * The key ARN of the customer managed customer master key (CMK) used for KMS encryption if you use KMS_BASED_ENCRYPTION. 1728 */ 1729 kmsKeyArn?: ARN; 1730 /** 1731 * The status of the account configuration. This contains the ConfigurationState. If there's an error, it also contains the ErrorDetails. 1732 */ 1733 configurationStatus: ConfigurationStatus; 1734 } 1735 export interface DescribeGatewayCapabilityConfigurationRequest { 1736 /** 1737 * The ID of the gateway that defines the capability configuration. 1738 */ 1739 gatewayId: ID; 1740 /** 1741 * The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1. 1742 */ 1743 capabilityNamespace: CapabilityNamespace; 1744 } 1745 export interface DescribeGatewayCapabilityConfigurationResponse { 1746 /** 1747 * The ID of the gateway that defines the capability configuration. 1748 */ 1749 gatewayId: ID; 1750 /** 1751 * The namespace of the gateway capability. 1752 */ 1753 capabilityNamespace: CapabilityNamespace; 1754 /** 1755 * The JSON document that defines the gateway capability's configuration. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide. 1756 */ 1757 capabilityConfiguration: CapabilityConfiguration; 1758 /** 1759 * The synchronization status of the capability configuration. The sync status can be one of the following: IN_SYNC – The gateway is running the capability configuration. OUT_OF_SYNC – The gateway hasn't received the capability configuration. SYNC_FAILED – The gateway rejected the capability configuration. 1760 */ 1761 capabilitySyncStatus: CapabilitySyncStatus; 1762 } 1763 export interface DescribeGatewayRequest { 1764 /** 1765 * The ID of the gateway device. 1766 */ 1767 gatewayId: ID; 1768 } 1769 export interface DescribeGatewayResponse { 1770 /** 1771 * The ID of the gateway device. 1772 */ 1773 gatewayId: ID; 1774 /** 1775 * The name of the gateway. 1776 */ 1777 gatewayName: Name; 1778 /** 1779 * The ARN of the gateway, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId} 1780 */ 1781 gatewayArn: ARN; 1782 /** 1783 * The gateway's platform. 1784 */ 1785 gatewayPlatform?: GatewayPlatform; 1786 /** 1787 * A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration. 1788 */ 1789 gatewayCapabilitySummaries: GatewayCapabilitySummaries; 1790 /** 1791 * The date the gateway was created, in Unix epoch time. 1792 */ 1793 creationDate: Timestamp; 1794 /** 1795 * The date the gateway was last updated, in Unix epoch time. 1796 */ 1797 lastUpdateDate: Timestamp; 1798 } 1799 export interface DescribeLoggingOptionsRequest { 1800 } 1801 export interface DescribeLoggingOptionsResponse { 1802 /** 1803 * The current logging options. 1804 */ 1805 loggingOptions: LoggingOptions; 1806 } 1807 export interface DescribePortalRequest { 1808 /** 1809 * The ID of the portal. 1810 */ 1811 portalId: ID; 1812 } 1813 export interface DescribePortalResponse { 1814 /** 1815 * The ID of the portal. 1816 */ 1817 portalId: ID; 1818 /** 1819 * The ARN of the portal, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} 1820 */ 1821 portalArn: ARN; 1822 /** 1823 * The name of the portal. 1824 */ 1825 portalName: Name; 1826 /** 1827 * The portal's description. 1828 */ 1829 portalDescription?: Description; 1830 /** 1831 * The Amazon Web Services SSO application generated client ID (used with Amazon Web Services SSO APIs). IoT SiteWise includes portalClientId for only portals that use Amazon Web Services SSO to authenticate users. 1832 */ 1833 portalClientId: PortalClientId; 1834 /** 1835 * The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use Amazon Web Services SSO for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal. 1836 */ 1837 portalStartUrl: Url; 1838 /** 1839 * The Amazon Web Services administrator's contact email address. 1840 */ 1841 portalContactEmail: Email; 1842 /** 1843 * The current status of the portal, which contains a state and any error message. 1844 */ 1845 portalStatus: PortalStatus; 1846 /** 1847 * The date the portal was created, in Unix epoch time. 1848 */ 1849 portalCreationDate: Timestamp; 1850 /** 1851 * The date the portal was last updated, in Unix epoch time. 1852 */ 1853 portalLastUpdateDate: Timestamp; 1854 /** 1855 * The portal's logo image, which is available at a URL. 1856 */ 1857 portalLogoImageLocation?: ImageLocation; 1858 /** 1859 * The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide. 1860 */ 1861 roleArn?: ARN; 1862 /** 1863 * The service to use to authenticate users to the portal. 1864 */ 1865 portalAuthMode?: AuthMode; 1866 /** 1867 * The email address that sends alarm notifications. 1868 */ 1869 notificationSenderEmail?: Email; 1870 /** 1871 * Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. 1872 */ 1873 alarms?: Alarms; 1874 } 1875 export interface DescribeProjectRequest { 1876 /** 1877 * The ID of the project. 1878 */ 1879 projectId: ID; 1880 } 1881 export interface DescribeProjectResponse { 1882 /** 1883 * The ID of the project. 1884 */ 1885 projectId: ID; 1886 /** 1887 * The ARN of the project, which has the following format. arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId} 1888 */ 1889 projectArn: ARN; 1890 /** 1891 * The name of the project. 1892 */ 1893 projectName: Name; 1894 /** 1895 * The ID of the portal that the project is in. 1896 */ 1897 portalId: ID; 1898 /** 1899 * The project's description. 1900 */ 1901 projectDescription?: Description; 1902 /** 1903 * The date the project was created, in Unix epoch time. 1904 */ 1905 projectCreationDate: Timestamp; 1906 /** 1907 * The date the project was last updated, in Unix epoch time. 1908 */ 1909 projectLastUpdateDate: Timestamp; 1910 } 1911 export interface DescribeStorageConfigurationRequest { 1912 } 1913 export interface DescribeStorageConfigurationResponse { 1914 /** 1915 * The type of storage that you specified for your data. The storage type can be one of the following values: SITEWISE_DEFAULT_STORAGE – IoT SiteWise replicates your data into a service managed database. MULTI_LAYER_STORAGE – IoT SiteWise replicates your data into a service managed database and saves a copy of your raw data and metadata in an Amazon S3 object that you specified. 1916 */ 1917 storageType: StorageType; 1918 /** 1919 * Contains information about the storage destination. 1920 */ 1921 multiLayerStorage?: MultiLayerStorage; 1922 configurationStatus: ConfigurationStatus; 1923 /** 1924 * The date the storage configuration was last updated, in Unix epoch time. 1925 */ 1926 lastUpdateDate?: Timestamp; 1927 } 1928 export type Description = string; 1929 export interface DetailedError { 1930 /** 1931 * The error code. 1932 */ 1933 code: DetailedErrorCode; 1934 /** 1935 * The error message. 1936 */ 1937 message: DetailedErrorMessage; 1938 } 1939 export type DetailedErrorCode = "INCOMPATIBLE_COMPUTE_LOCATION"|"INCOMPATIBLE_FORWARDING_CONFIGURATION"|string; 1940 export type DetailedErrorMessage = string; 1941 export type DetailedErrors = DetailedError[]; 1942 export interface DisassociateAssetsRequest { 1943 /** 1944 * The ID of the parent asset from which to disassociate the child asset. 1945 */ 1946 assetId: ID; 1947 /** 1948 * The ID of a hierarchy in the parent asset's model. Hierarchies allow different groupings of assets to be formed that all come from the same asset model. You can use the hierarchy ID to identify the correct asset to disassociate. For more information, see Asset hierarchies in the IoT SiteWise User Guide. 1949 */ 1950 hierarchyId: ID; 1951 /** 1952 * The ID of the child asset to disassociate. 1953 */ 1954 childAssetId: ID; 1955 /** 1956 * 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. 1957 */ 1958 clientToken?: ClientToken; 1959 } 1960 export type Email = string; 1961 export type EncryptionType = "SITEWISE_DEFAULT_ENCRYPTION"|"KMS_BASED_ENCRYPTION"|string; 1962 export type EntryId = string; 1963 export type ErrorCode = "VALIDATION_ERROR"|"INTERNAL_FAILURE"|string; 1964 export interface ErrorDetails { 1965 /** 1966 * The error code. 1967 */ 1968 code: ErrorCode; 1969 /** 1970 * The error message. 1971 */ 1972 message: ErrorMessage; 1973 /** 1974 * A list of detailed errors. 1975 */ 1976 details?: DetailedErrors; 1977 } 1978 export type ErrorMessage = string; 1979 export type Expression = string; 1980 export interface ExpressionVariable { 1981 /** 1982 * The friendly name of the variable to be used in the expression. 1983 */ 1984 name: VariableName; 1985 /** 1986 * The variable that identifies an asset property from which to use values. 1987 */ 1988 value: VariableValue; 1989 } 1990 export type ExpressionVariables = ExpressionVariable[]; 1991 export interface ForwardingConfig { 1992 /** 1993 * The forwarding state for the given property. 1994 */ 1995 state: ForwardingConfigState; 1996 } 1997 export type ForwardingConfigState = "DISABLED"|"ENABLED"|string; 1998 export type GatewayCapabilitySummaries = GatewayCapabilitySummary[]; 1999 export interface GatewayCapabilitySummary { 2000 /** 2001 * The namespace of the capability configuration. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1. 2002 */ 2003 capabilityNamespace: CapabilityNamespace; 2004 /** 2005 * The synchronization status of the capability configuration. The sync status can be one of the following: IN_SYNC – The gateway is running the capability configuration. OUT_OF_SYNC – The gateway hasn't received the capability configuration. SYNC_FAILED – The gateway rejected the capability configuration. 2006 */ 2007 capabilitySyncStatus: CapabilitySyncStatus; 2008 } 2009 export interface GatewayPlatform { 2010 /** 2011 * A gateway that runs on IoT Greengrass. 2012 */ 2013 greengrass?: Greengrass; 2014 /** 2015 * A gateway that runs on IoT Greengrass V2. 2016 */ 2017 greengrassV2?: GreengrassV2; 2018 } 2019 export type GatewaySummaries = GatewaySummary[]; 2020 export interface GatewaySummary { 2021 /** 2022 * The ID of the gateway device. 2023 */ 2024 gatewayId: ID; 2025 /** 2026 * The name of the asset. 2027 */ 2028 gatewayName: Name; 2029 gatewayPlatform?: GatewayPlatform; 2030 /** 2031 * A list of gateway capability summaries that each contain a namespace and status. Each gateway capability defines data sources for the gateway. To retrieve a capability configuration's definition, use DescribeGatewayCapabilityConfiguration. 2032 */ 2033 gatewayCapabilitySummaries?: GatewayCapabilitySummaries; 2034 /** 2035 * The date the gateway was created, in Unix epoch time. 2036 */ 2037 creationDate: Timestamp; 2038 /** 2039 * The date the gateway was last updated, in Unix epoch time. 2040 */ 2041 lastUpdateDate: Timestamp; 2042 } 2043 export interface GetAssetPropertyAggregatesRequest { 2044 /** 2045 * The ID of the asset. 2046 */ 2047 assetId?: ID; 2048 /** 2049 * The ID of the asset property. 2050 */ 2051 propertyId?: ID; 2052 /** 2053 * The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. 2054 */ 2055 propertyAlias?: AssetPropertyAlias; 2056 /** 2057 * The data aggregating function. 2058 */ 2059 aggregateTypes: AggregateTypes; 2060 /** 2061 * The time interval over which to aggregate data. 2062 */ 2063 resolution: Resolution; 2064 /** 2065 * The quality by which to filter asset data. 2066 */ 2067 qualities?: Qualities; 2068 /** 2069 * The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time. 2070 */ 2071 startDate: Timestamp; 2072 /** 2073 * The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time. 2074 */ 2075 endDate: Timestamp; 2076 /** 2077 * The chronological sorting order of the requested information. Default: ASCENDING 2078 */ 2079 timeOrdering?: TimeOrdering; 2080 /** 2081 * The token to be used for the next set of paginated results. 2082 */ 2083 nextToken?: NextToken; 2084 /** 2085 * The maximum number of results to return for each paginated request. Default: 100 2086 */ 2087 maxResults?: MaxResults; 2088 } 2089 export interface GetAssetPropertyAggregatesResponse { 2090 /** 2091 * The requested aggregated values. 2092 */ 2093 aggregatedValues: AggregatedValues; 2094 /** 2095 * The token for the next set of results, or null if there are no additional results. 2096 */ 2097 nextToken?: NextToken; 2098 } 2099 export interface GetAssetPropertyValueHistoryRequest { 2100 /** 2101 * The ID of the asset. 2102 */ 2103 assetId?: ID; 2104 /** 2105 * The ID of the asset property. 2106 */ 2107 propertyId?: ID; 2108 /** 2109 * The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. 2110 */ 2111 propertyAlias?: AssetPropertyAlias; 2112 /** 2113 * The exclusive start of the range from which to query historical data, expressed in seconds in Unix epoch time. 2114 */ 2115 startDate?: Timestamp; 2116 /** 2117 * The inclusive end of the range from which to query historical data, expressed in seconds in Unix epoch time. 2118 */ 2119 endDate?: Timestamp; 2120 /** 2121 * The quality by which to filter asset data. 2122 */ 2123 qualities?: Qualities; 2124 /** 2125 * The chronological sorting order of the requested information. Default: ASCENDING 2126 */ 2127 timeOrdering?: TimeOrdering; 2128 /** 2129 * The token to be used for the next set of paginated results. 2130 */ 2131 nextToken?: NextToken; 2132 /** 2133 * The maximum number of results to return for each paginated request. Default: 100 2134 */ 2135 maxResults?: MaxResults; 2136 } 2137 export interface GetAssetPropertyValueHistoryResponse { 2138 /** 2139 * The asset property's value history. 2140 */ 2141 assetPropertyValueHistory: AssetPropertyValueHistory; 2142 /** 2143 * The token for the next set of results, or null if there are no additional results. 2144 */ 2145 nextToken?: NextToken; 2146 } 2147 export interface GetAssetPropertyValueRequest { 2148 /** 2149 * The ID of the asset. 2150 */ 2151 assetId?: ID; 2152 /** 2153 * The ID of the asset property. 2154 */ 2155 propertyId?: ID; 2156 /** 2157 * The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. 2158 */ 2159 propertyAlias?: AssetPropertyAlias; 2160 } 2161 export interface GetAssetPropertyValueResponse { 2162 /** 2163 * The current asset property value. 2164 */ 2165 propertyValue?: AssetPropertyValue; 2166 } 2167 export interface GetInterpolatedAssetPropertyValuesRequest { 2168 /** 2169 * The ID of the asset. 2170 */ 2171 assetId?: ID; 2172 /** 2173 * The ID of the asset property. 2174 */ 2175 propertyId?: ID; 2176 /** 2177 * The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. 2178 */ 2179 propertyAlias?: AssetPropertyAlias; 2180 /** 2181 * The exclusive start of the range from which to interpolate data, expressed in seconds in Unix epoch time. 2182 */ 2183 startTimeInSeconds: TimeInSeconds; 2184 /** 2185 * The nanosecond offset converted from startTimeInSeconds. 2186 */ 2187 startTimeOffsetInNanos?: OffsetInNanos; 2188 /** 2189 * The inclusive end of the range from which to interpolate data, expressed in seconds in Unix epoch time. 2190 */ 2191 endTimeInSeconds: TimeInSeconds; 2192 /** 2193 * The nanosecond offset converted from endTimeInSeconds. 2194 */ 2195 endTimeOffsetInNanos?: OffsetInNanos; 2196 /** 2197 * The quality of the asset property value. You can use this parameter as a filter to choose only the asset property values that have a specific quality. 2198 */ 2199 quality: Quality; 2200 /** 2201 * The time interval in seconds over which to interpolate data. Each interval starts when the previous one ends. 2202 */ 2203 intervalInSeconds: IntervalInSeconds; 2204 /** 2205 * The token to be used for the next set of paginated results. 2206 */ 2207 nextToken?: NextToken; 2208 /** 2209 * The maximum number of results to return for each paginated request. If not specified, the default value is 10. 2210 */ 2211 maxResults?: MaxInterpolatedResults; 2212 /** 2213 * The interpolation type. Valid values: LINEAR_INTERPOLATION | LOCF_INTERPOLATION LINEAR_INTERPOLATION – Estimates missing data using linear interpolation. For example, you can use this operation to return the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM, IoT SiteWise returns the first interpolated value on July 2, 2021, at 9 AM, the second interpolated value on July 3, 2021, at 9 AM, and so on. LOCF_INTERPOLATION – Estimates missing data using last observation carried forward interpolation If no data point is found for an interval, IoT SiteWise returns the last observed data point for the previous interval and carries forward this interpolated value until a new data point is found. For example, you can get the state of an on-off valve every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM, IoT SiteWise returns the last observed data point between July 1, 2021, at 9 AM and July 2, 2021, at 9 AM as the first interpolated value. If no data point is found after 9 AM on July 2, 2021, IoT SiteWise uses the same interpolated value for the rest of the days. 2214 */ 2215 type: InterpolationType; 2216 /** 2217 * The query interval for the window in seconds. IoT SiteWise computes each interpolated value by using data points from the timestamp of each interval minus the window to the timestamp of each interval plus the window. If not specified, the window is between the start time minus the interval and the end time plus the interval. If you specify a value for the intervalWindowInSeconds parameter, the type parameter must be LINEAR_INTERPOLATION. If no data point is found during the specified query window, IoT SiteWise won't return an interpolated value for the interval. This indicates that there's a gap in the ingested data points. For example, you can get the interpolated temperature values for a wind turbine every 24 hours over a duration of 7 days. If the interpolation starts on July 1, 2021, at 9 AM with a window of 2 hours, IoT SiteWise uses the data points from 7 AM (9 AM - 2 hours) to 11 AM (9 AM + 2 hours) on July 2, 2021 to compute the first interpolated value, uses the data points from 7 AM (9 AM - 2 hours) to 11 AM (9 AM + 2 hours) on July 3, 2021 to compute the second interpolated value, and so on. 2218 */ 2219 intervalWindowInSeconds?: IntervalWindowInSeconds; 2220 } 2221 export interface GetInterpolatedAssetPropertyValuesResponse { 2222 /** 2223 * The requested interpolated values. 2224 */ 2225 interpolatedAssetPropertyValues: InterpolatedAssetPropertyValues; 2226 /** 2227 * The token for the next set of results, or null if there are no additional results. 2228 */ 2229 nextToken?: NextToken; 2230 } 2231 export interface Greengrass { 2232 /** 2233 * The ARN of the Greengrass group. For more information about how to find a group's ARN, see ListGroups and GetGroup in the IoT Greengrass API Reference. 2234 */ 2235 groupArn: ARN; 2236 } 2237 export interface GreengrassV2 { 2238 /** 2239 * The name of the IoT thing for your IoT Greengrass V2 core device. 2240 */ 2241 coreDeviceThingName: CoreDeviceThingName; 2242 } 2243 export interface GroupIdentity { 2244 /** 2245 * The Amazon Web Services SSO ID of the group. 2246 */ 2247 id: IdentityId; 2248 } 2249 export interface IAMRoleIdentity { 2250 /** 2251 * The ARN of the IAM role. For more information, see IAM ARNs in the IAM User Guide. 2252 */ 2253 arn: ARN; 2254 } 2255 export interface IAMUserIdentity { 2256 /** 2257 * The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide. If you delete the IAM user, access policies that contain this identity include an empty arn. You can delete the access policy for the IAM user that no longer exists. 2258 */ 2259 arn: ARN; 2260 } 2261 export type ID = string; 2262 export type IDs = ID[]; 2263 export interface Identity { 2264 /** 2265 * An Amazon Web Services SSO user identity. 2266 */ 2267 user?: UserIdentity; 2268 /** 2269 * An Amazon Web Services SSO group identity. 2270 */ 2271 group?: GroupIdentity; 2272 /** 2273 * An IAM user identity. 2274 */ 2275 iamUser?: IAMUserIdentity; 2276 /** 2277 * An IAM role identity. 2278 */ 2279 iamRole?: IAMRoleIdentity; 2280 } 2281 export type IdentityId = string; 2282 export type IdentityType = "USER"|"GROUP"|"IAM"|string; 2283 export interface Image { 2284 /** 2285 * The ID of an existing image. Specify this parameter to keep an existing image. 2286 */ 2287 id?: ID; 2288 file?: ImageFile; 2289 } 2290 export interface ImageFile { 2291 /** 2292 * The image file contents, represented as a base64-encoded string. The file size must be less than 1 MB. 2293 */ 2294 data: ImageFileData; 2295 /** 2296 * The file type of the image. 2297 */ 2298 type: ImageFileType; 2299 } 2300 export type ImageFileData = Buffer|Uint8Array|Blob|string; 2301 export type ImageFileType = "PNG"|string; 2302 export interface ImageLocation { 2303 /** 2304 * The ID of the image. 2305 */ 2306 id: ID; 2307 /** 2308 * The URL where the image is available. The URL is valid for 15 minutes so that you can view and download the image 2309 */ 2310 url: Url; 2311 } 2312 export interface InterpolatedAssetPropertyValue { 2313 timestamp: TimeInNanos; 2314 value: Variant; 2315 } 2316 export type InterpolatedAssetPropertyValues = InterpolatedAssetPropertyValue[]; 2317 export type InterpolationType = string; 2318 export type Interval = string; 2319 export type IntervalInSeconds = number; 2320 export type IntervalWindowInSeconds = number; 2321 export type KmsKeyId = string; 2322 export interface ListAccessPoliciesRequest { 2323 /** 2324 * The type of identity (Amazon Web Services SSO user, Amazon Web Services SSO group, or IAM user). This parameter is required if you specify identityId. 2325 */ 2326 identityType?: IdentityType; 2327 /** 2328 * The ID of the identity. This parameter is required if you specify USER or GROUP for identityType. 2329 */ 2330 identityId?: IdentityId; 2331 /** 2332 * The type of resource (portal or project). This parameter is required if you specify resourceId. 2333 */ 2334 resourceType?: ResourceType; 2335 /** 2336 * The ID of the resource. This parameter is required if you specify resourceType. 2337 */ 2338 resourceId?: ID; 2339 /** 2340 * The ARN of the IAM user. For more information, see IAM ARNs in the IAM User Guide. This parameter is required if you specify IAM for identityType. 2341 */ 2342 iamArn?: ARN; 2343 /** 2344 * The token to be used for the next set of paginated results. 2345 */ 2346 nextToken?: NextToken; 2347 /** 2348 * The maximum number of results to return for each paginated request. Default: 50 2349 */ 2350 maxResults?: MaxResults; 2351 } 2352 export interface ListAccessPoliciesResponse { 2353 /** 2354 * A list that summarizes each access policy. 2355 */ 2356 accessPolicySummaries: AccessPolicySummaries; 2357 /** 2358 * The token for the next set of results, or null if there are no additional results. 2359 */ 2360 nextToken?: NextToken; 2361 } 2362 export interface ListAssetModelsRequest { 2363 /** 2364 * The token to be used for the next set of paginated results. 2365 */ 2366 nextToken?: NextToken; 2367 /** 2368 * The maximum number of results to return for each paginated request. Default: 50 2369 */ 2370 maxResults?: MaxResults; 2371 } 2372 export interface ListAssetModelsResponse { 2373 /** 2374 * A list that summarizes each asset model. 2375 */ 2376 assetModelSummaries: AssetModelSummaries; 2377 /** 2378 * The token for the next set of results, or null if there are no additional results. 2379 */ 2380 nextToken?: NextToken; 2381 } 2382 export interface ListAssetRelationshipsRequest { 2383 /** 2384 * The ID of the asset. 2385 */ 2386 assetId: ID; 2387 /** 2388 * The type of traversal to use to identify asset relationships. Choose the following option: PATH_TO_ROOT – Identify the asset's parent assets up to the root asset. The asset that you specify in assetId is the first result in the list of assetRelationshipSummaries, and the root asset is the last result. 2389 */ 2390 traversalType: TraversalType; 2391 /** 2392 * The token to be used for the next set of paginated results. 2393 */ 2394 nextToken?: NextToken; 2395 /** 2396 * The maximum number of results to return for each paginated request. 2397 */ 2398 maxResults?: MaxResults; 2399 } 2400 export interface ListAssetRelationshipsResponse { 2401 /** 2402 * A list that summarizes each asset relationship. 2403 */ 2404 assetRelationshipSummaries: AssetRelationshipSummaries; 2405 /** 2406 * The token for the next set of results, or null if there are no additional results. 2407 */ 2408 nextToken?: NextToken; 2409 } 2410 export type ListAssetsFilter = "ALL"|"TOP_LEVEL"|string; 2411 export interface ListAssetsRequest { 2412 /** 2413 * The token to be used for the next set of paginated results. 2414 */ 2415 nextToken?: NextToken; 2416 /** 2417 * The maximum number of results to return for each paginated request. Default: 50 2418 */ 2419 maxResults?: MaxResults; 2420 /** 2421 * The ID of the asset model by which to filter the list of assets. This parameter is required if you choose ALL for filter. 2422 */ 2423 assetModelId?: ID; 2424 /** 2425 * The filter for the requested list of assets. Choose one of the following options: ALL – The list includes all assets for a given asset model ID. The assetModelId parameter is required if you filter by ALL. TOP_LEVEL – The list includes only top-level assets in the asset hierarchy tree. Default: ALL 2426 */ 2427 filter?: ListAssetsFilter; 2428 } 2429 export interface ListAssetsResponse { 2430 /** 2431 * A list that summarizes each asset. 2432 */ 2433 assetSummaries: AssetSummaries; 2434 /** 2435 * The token for the next set of results, or null if there are no additional results. 2436 */ 2437 nextToken?: NextToken; 2438 } 2439 export interface ListAssociatedAssetsRequest { 2440 /** 2441 * The ID of the asset to query. 2442 */ 2443 assetId: ID; 2444 /** 2445 * The ID of the hierarchy by which child assets are associated to the asset. 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. 2446 */ 2447 hierarchyId?: ID; 2448 /** 2449 * 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 2450 */ 2451 traversalDirection?: TraversalDirection; 2452 /** 2453 * The token to be used for the next set of paginated results. 2454 */ 2455 nextToken?: NextToken; 2456 /** 2457 * The maximum number of results to return for each paginated request. Default: 50 2458 */ 2459 maxResults?: MaxResults; 2460 } 2461 export interface ListAssociatedAssetsResponse { 2462 /** 2463 * A list that summarizes the associated assets. 2464 */ 2465 assetSummaries: AssociatedAssetsSummaries; 2466 /** 2467 * The token for the next set of results, or null if there are no additional results. 2468 */ 2469 nextToken?: NextToken; 2470 } 2471 export interface ListDashboardsRequest { 2472 /** 2473 * The ID of the project. 2474 */ 2475 projectId: ID; 2476 /** 2477 * The token to be used for the next set of paginated results. 2478 */ 2479 nextToken?: NextToken; 2480 /** 2481 * The maximum number of results to return for each paginated request. Default: 50 2482 */ 2483 maxResults?: MaxResults; 2484 } 2485 export interface ListDashboardsResponse { 2486 /** 2487 * A list that summarizes each dashboard in the project. 2488 */ 2489 dashboardSummaries: DashboardSummaries; 2490 /** 2491 * The token for the next set of results, or null if there are no additional results. 2492 */ 2493 nextToken?: NextToken; 2494 } 2495 export interface ListGatewaysRequest { 2496 /** 2497 * The token to be used for the next set of paginated results. 2498 */ 2499 nextToken?: NextToken; 2500 /** 2501 * The maximum number of results to return for each paginated request. Default: 50 2502 */ 2503 maxResults?: MaxResults; 2504 } 2505 export interface ListGatewaysResponse { 2506 /** 2507 * A list that summarizes each gateway. 2508 */ 2509 gatewaySummaries: GatewaySummaries; 2510 /** 2511 * The token for the next set of results, or null if there are no additional results. 2512 */ 2513 nextToken?: NextToken; 2514 } 2515 export interface ListPortalsRequest { 2516 /** 2517 * The token to be used for the next set of paginated results. 2518 */ 2519 nextToken?: NextToken; 2520 /** 2521 * The maximum number of results to return for each paginated request. Default: 50 2522 */ 2523 maxResults?: MaxResults; 2524 } 2525 export interface ListPortalsResponse { 2526 /** 2527 * A list that summarizes each portal. 2528 */ 2529 portalSummaries?: PortalSummaries; 2530 /** 2531 * The token for the next set of results, or null if there are no additional results. 2532 */ 2533 nextToken?: NextToken; 2534 } 2535 export interface ListProjectAssetsRequest { 2536 /** 2537 * The ID of the project. 2538 */ 2539 projectId: ID; 2540 /** 2541 * The token to be used for the next set of paginated results. 2542 */ 2543 nextToken?: NextToken; 2544 /** 2545 * The maximum number of results to return for each paginated request. Default: 50 2546 */ 2547 maxResults?: MaxResults; 2548 } 2549 export interface ListProjectAssetsResponse { 2550 /** 2551 * A list that contains the IDs of each asset associated with the project. 2552 */ 2553 assetIds: AssetIDs; 2554 /** 2555 * The token for the next set of results, or null if there are no additional results. 2556 */ 2557 nextToken?: NextToken; 2558 } 2559 export interface ListProjectsRequest { 2560 /** 2561 * The ID of the portal. 2562 */ 2563 portalId: ID; 2564 /** 2565 * The token to be used for the next set of paginated results. 2566 */ 2567 nextToken?: NextToken; 2568 /** 2569 * The maximum number of results to return for each paginated request. Default: 50 2570 */ 2571 maxResults?: MaxResults; 2572 } 2573 export interface ListProjectsResponse { 2574 /** 2575 * A list that summarizes each project in the portal. 2576 */ 2577 projectSummaries: ProjectSummaries; 2578 /** 2579 * The token for the next set of results, or null if there are no additional results. 2580 */ 2581 nextToken?: NextToken; 2582 } 2583 export interface ListTagsForResourceRequest { 2584 /** 2585 * The ARN of the resource. 2586 */ 2587 resourceArn: AmazonResourceName; 2588 } 2589 export interface ListTagsForResourceResponse { 2590 /** 2591 * The list of key-value pairs that contain metadata for the resource. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide. 2592 */ 2593 tags?: TagMap; 2594 } 2595 export type LoggingLevel = "ERROR"|"INFO"|"OFF"|string; 2596 export interface LoggingOptions { 2597 /** 2598 * The IoT SiteWise logging verbosity level. 2599 */ 2600 level: LoggingLevel; 2601 } 2602 export type Macro = string; 2603 export type MaxInterpolatedResults = number; 2604 export type MaxResults = number; 2605 export interface Measurement { 2606 /** 2607 * The processing configuration for the given measurement property. You can configure measurements to be kept at the edge or forwarded to the Amazon Web Services Cloud. By default, measurements are forwarded to the cloud. 2608 */ 2609 processingConfig?: MeasurementProcessingConfig; 2610 } 2611 export interface MeasurementProcessingConfig { 2612 /** 2613 * The forwarding configuration for the given measurement property. 2614 */ 2615 forwardingConfig: ForwardingConfig; 2616 } 2617 export interface Metric { 2618 /** 2619 * The mathematical expression that defines the metric aggregation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression. For more information, see Quotas in the IoT SiteWise User Guide. 2620 */ 2621 expression: Expression; 2622 /** 2623 * The list of variables used in the expression. 2624 */ 2625 variables: ExpressionVariables; 2626 /** 2627 * The window (time interval) over which IoT SiteWise computes the metric's aggregation expression. IoT SiteWise computes one data point per window. 2628 */ 2629 window: MetricWindow; 2630 /** 2631 * The processing configuration for the given metric property. You can configure metrics to be computed at the edge or in the Amazon Web Services Cloud. By default, metrics are forwarded to the cloud. 2632 */ 2633 processingConfig?: MetricProcessingConfig; 2634 } 2635 export interface MetricProcessingConfig { 2636 /** 2637 * The compute location for the given metric property. 2638 */ 2639 computeLocation: ComputeLocation; 2640 } 2641 export interface MetricWindow { 2642 /** 2643 * The tumbling time interval window. 2644 */ 2645 tumbling?: TumblingWindow; 2646 } 2647 export type MonitorErrorCode = "INTERNAL_FAILURE"|"VALIDATION_ERROR"|"LIMIT_EXCEEDED"|string; 2648 export interface MonitorErrorDetails { 2649 /** 2650 * The error code. 2651 */ 2652 code?: MonitorErrorCode; 2653 /** 2654 * The error message. 2655 */ 2656 message?: MonitorErrorMessage; 2657 } 2658 export type MonitorErrorMessage = string; 2659 export interface MultiLayerStorage { 2660 /** 2661 * Contains information about a customer managed Amazon S3 bucket. 2662 */ 2663 customerManagedS3Storage: CustomerManagedS3Storage; 2664 } 2665 export type Name = string; 2666 export type NextToken = string; 2667 export type Offset = string; 2668 export type OffsetInNanos = number; 2669 export type Permission = "ADMINISTRATOR"|"VIEWER"|string; 2670 export type PortalClientId = string; 2671 export interface PortalResource { 2672 /** 2673 * The ID of the portal. 2674 */ 2675 id: ID; 2676 } 2677 export type PortalState = "CREATING"|"UPDATING"|"DELETING"|"ACTIVE"|"FAILED"|string; 2678 export interface PortalStatus { 2679 /** 2680 * The current state of the portal. 2681 */ 2682 state: PortalState; 2683 /** 2684 * Contains associated error information, if any. 2685 */ 2686 error?: MonitorErrorDetails; 2687 } 2688 export type PortalSummaries = PortalSummary[]; 2689 export interface PortalSummary { 2690 /** 2691 * The ID of the portal. 2692 */ 2693 id: ID; 2694 /** 2695 * The name of the portal. 2696 */ 2697 name: Name; 2698 /** 2699 * The portal's description. 2700 */ 2701 description?: Description; 2702 /** 2703 * The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use Amazon Web Services SSO for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal. 2704 */ 2705 startUrl: Url; 2706 /** 2707 * The date the portal was created, in Unix epoch time. 2708 */ 2709 creationDate?: Timestamp; 2710 /** 2711 * The date the portal was last updated, in Unix epoch time. 2712 */ 2713 lastUpdateDate?: Timestamp; 2714 /** 2715 * The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide. 2716 */ 2717 roleArn?: ARN; 2718 status: PortalStatus; 2719 } 2720 export interface ProjectResource { 2721 /** 2722 * The ID of the project. 2723 */ 2724 id: ID; 2725 } 2726 export type ProjectSummaries = ProjectSummary[]; 2727 export interface ProjectSummary { 2728 /** 2729 * The ID of the project. 2730 */ 2731 id: ID; 2732 /** 2733 * The name of the project. 2734 */ 2735 name: Name; 2736 /** 2737 * The project's description. 2738 */ 2739 description?: Description; 2740 /** 2741 * The date the project was created, in Unix epoch time. 2742 */ 2743 creationDate?: Timestamp; 2744 /** 2745 * The date the project was last updated, in Unix epoch time. 2746 */ 2747 lastUpdateDate?: Timestamp; 2748 } 2749 export interface Property { 2750 /** 2751 * The ID of the asset property. 2752 */ 2753 id: ID; 2754 /** 2755 * The name of the property. 2756 */ 2757 name: Name; 2758 /** 2759 * The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. 2760 */ 2761 alias?: PropertyAlias; 2762 /** 2763 * The asset property's notification topic and state. For more information, see UpdateAssetProperty. 2764 */ 2765 notification?: PropertyNotification; 2766 /** 2767 * The property data type. 2768 */ 2769 dataType: PropertyDataType; 2770 /** 2771 * The unit (such as Newtons or RPM) of the asset property. 2772 */ 2773 unit?: PropertyUnit; 2774 /** 2775 * The property type (see PropertyType). A property contains one type. 2776 */ 2777 type?: PropertyType; 2778 } 2779 export type PropertyAlias = string; 2780 export type PropertyDataType = "STRING"|"INTEGER"|"DOUBLE"|"BOOLEAN"|"STRUCT"|string; 2781 export interface PropertyNotification { 2782 /** 2783 * The MQTT topic to which IoT SiteWise publishes property value update notifications. 2784 */ 2785 topic: PropertyNotificationTopic; 2786 /** 2787 * The current notification state. 2788 */ 2789 state: PropertyNotificationState; 2790 } 2791 export type PropertyNotificationState = "ENABLED"|"DISABLED"|string; 2792 export type PropertyNotificationTopic = string; 2793 export interface PropertyType { 2794 /** 2795 * Specifies an asset attribute property. An attribute generally contains static information, such as the serial number of an IIoT wind turbine. 2796 */ 2797 attribute?: Attribute; 2798 /** 2799 * Specifies an asset measurement property. A measurement represents a device's raw sensor data stream, such as timestamped temperature values or timestamped power values. 2800 */ 2801 measurement?: Measurement; 2802 /** 2803 * Specifies an asset transform property. A transform contains a mathematical expression that maps a property's data points from one form to another, such as a unit conversion from Celsius to Fahrenheit. 2804 */ 2805 transform?: Transform; 2806 /** 2807 * Specifies an asset metric property. A metric contains a mathematical expression that uses aggregate functions to process all input data points over a time interval and output a single data point, such as to calculate the average hourly temperature. 2808 */ 2809 metric?: Metric; 2810 } 2811 export type PropertyUnit = string; 2812 export type PropertyValueBooleanValue = boolean; 2813 export type PropertyValueDoubleValue = number; 2814 export type PropertyValueIntegerValue = number; 2815 export type PropertyValueStringValue = string; 2816 export type PutAssetPropertyValueEntries = PutAssetPropertyValueEntry[]; 2817 export interface PutAssetPropertyValueEntry { 2818 /** 2819 * The user specified ID for the entry. You can use this ID to identify which entries failed. 2820 */ 2821 entryId: EntryId; 2822 /** 2823 * The ID of the asset to update. 2824 */ 2825 assetId?: ID; 2826 /** 2827 * The ID of the asset property for this entry. 2828 */ 2829 propertyId?: ID; 2830 /** 2831 * The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. 2832 */ 2833 propertyAlias?: AssetPropertyAlias; 2834 /** 2835 * The list of property values to upload. You can specify up to 10 propertyValues array elements. 2836 */ 2837 propertyValues: AssetPropertyValues; 2838 } 2839 export interface PutDefaultEncryptionConfigurationRequest { 2840 /** 2841 * The type of encryption used for the encryption configuration. 2842 */ 2843 encryptionType: EncryptionType; 2844 /** 2845 * The Key ID of the customer managed customer master key (CMK) used for KMS encryption. This is required if you use KMS_BASED_ENCRYPTION. 2846 */ 2847 kmsKeyId?: KmsKeyId; 2848 } 2849 export interface PutDefaultEncryptionConfigurationResponse { 2850 /** 2851 * The type of encryption used for the encryption configuration. 2852 */ 2853 encryptionType: EncryptionType; 2854 /** 2855 * The Key ARN of the KMS CMK used for KMS encryption if you use KMS_BASED_ENCRYPTION. 2856 */ 2857 kmsKeyArn?: ARN; 2858 /** 2859 * The status of the account configuration. This contains the ConfigurationState. If there is an error, it also contains the ErrorDetails. 2860 */ 2861 configurationStatus: ConfigurationStatus; 2862 } 2863 export interface PutLoggingOptionsRequest { 2864 /** 2865 * The logging options to set. 2866 */ 2867 loggingOptions: LoggingOptions; 2868 } 2869 export interface PutLoggingOptionsResponse { 2870 } 2871 export interface PutStorageConfigurationRequest { 2872 /** 2873 * The type of storage that you specified for your data. The storage type can be one of the following values: SITEWISE_DEFAULT_STORAGE – IoT SiteWise replicates your data into a service managed database. MULTI_LAYER_STORAGE – IoT SiteWise replicates your data into a service managed database and saves a copy of your raw data and metadata in an Amazon S3 object that you specified. 2874 */ 2875 storageType: StorageType; 2876 /** 2877 * Identifies a storage destination. If you specified MULTI_LAYER_STORAGE for the storage type, you must specify a MultiLayerStorage object. 2878 */ 2879 multiLayerStorage?: MultiLayerStorage; 2880 } 2881 export interface PutStorageConfigurationResponse { 2882 /** 2883 * The type of storage that you specified for your data. The storage type can be one of the following values: SITEWISE_DEFAULT_STORAGE – IoT SiteWise replicates your data into a service managed database. MULTI_LAYER_STORAGE – IoT SiteWise replicates your data into a service managed database and saves a copy of your raw data and metadata in an Amazon S3 object that you specified. 2884 */ 2885 storageType: StorageType; 2886 /** 2887 * Contains information about the storage destination. 2888 */ 2889 multiLayerStorage?: MultiLayerStorage; 2890 configurationStatus: ConfigurationStatus; 2891 } 2892 export type Qualities = Quality[]; 2893 export type Quality = "GOOD"|"BAD"|"UNCERTAIN"|string; 2894 export type Resolution = string; 2895 export interface Resource { 2896 /** 2897 * A portal resource. 2898 */ 2899 portal?: PortalResource; 2900 /** 2901 * A project resource. 2902 */ 2903 project?: ProjectResource; 2904 } 2905 export type ResourceType = "PORTAL"|"PROJECT"|string; 2906 export type SSOApplicationId = string; 2907 export type StorageType = "SITEWISE_DEFAULT_STORAGE"|"MULTI_LAYER_STORAGE"|string; 2908 export type TagKey = string; 2909 export type TagKeyList = TagKey[]; 2910 export type TagMap = {[key: string]: TagValue}; 2911 export interface TagResourceRequest { 2912 /** 2913 * The ARN of the resource to tag. 2914 */ 2915 resourceArn: AmazonResourceName; 2916 /** 2917 * A list of key-value pairs that contain metadata for the resource. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide. 2918 */ 2919 tags: TagMap; 2920 } 2921 export interface TagResourceResponse { 2922 } 2923 export type TagValue = string; 2924 export interface TimeInNanos { 2925 /** 2926 * The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos. 2927 */ 2928 timeInSeconds: TimeInSeconds; 2929 /** 2930 * The nanosecond offset from timeInSeconds. 2931 */ 2932 offsetInNanos?: OffsetInNanos; 2933 } 2934 export type TimeInSeconds = number; 2935 export type TimeOrdering = "ASCENDING"|"DESCENDING"|string; 2936 export type Timestamp = Date; 2937 export type Timestamps = TimeInNanos[]; 2938 export interface Transform { 2939 /** 2940 * The mathematical expression that defines the transformation function. You can specify up to 10 variables per expression. You can specify up to 10 functions per expression. For more information, see Quotas in the IoT SiteWise User Guide. 2941 */ 2942 expression: Expression; 2943 /** 2944 * The list of variables used in the expression. 2945 */ 2946 variables: ExpressionVariables; 2947 /** 2948 * The processing configuration for the given transform property. You can configure transforms to be kept at the edge or forwarded to the Amazon Web Services Cloud. You can also configure transforms to be computed at the edge or in the cloud. 2949 */ 2950 processingConfig?: TransformProcessingConfig; 2951 } 2952 export interface TransformProcessingConfig { 2953 /** 2954 * The compute location for the given transform property. 2955 */ 2956 computeLocation: ComputeLocation; 2957 forwardingConfig?: ForwardingConfig; 2958 } 2959 export type TraversalDirection = "PARENT"|"CHILD"|string; 2960 export type TraversalType = "PATH_TO_ROOT"|string; 2961 export interface TumblingWindow { 2962 /** 2963 * The time interval for the tumbling window. The interval time must be between 1 minute and 1 week. IoT SiteWise computes the 1w interval the end of Sunday at midnight each week (UTC), the 1d interval at the end of each day at midnight (UTC), the 1h interval at the end of each hour, and so on. When IoT SiteWise aggregates data points for metric computations, the start of each interval is exclusive and the end of each interval is inclusive. IoT SiteWise places the computed data point at the end of the interval. 2964 */ 2965 interval: Interval; 2966 /** 2967 * The offset for the tumbling window. The offset parameter accepts the following: The offset time. For example, if you specify 18h for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways: If you create the metric before or at 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric. If you create the metric after 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day. The ISO 8601 format. For example, if you specify PT18H for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways: If you create the metric before or at 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) on the day when you create the metric. If you create the metric after 6:00 PM (UTC), you get the first aggregation result at 6 PM (UTC) the next day. The 24-hour clock. For example, if you specify 00:03:00 for offset and 5m for interval, and you create the metric at 2 PM (UTC), you get the first aggregation result at 2:03 PM (UTC). You get the second aggregation result at 2:08 PM (UTC). The offset time zone. For example, if you specify 2021-07-23T18:00-08 for offset and 1d for interval, IoT SiteWise aggregates data in one of the following ways: If you create the metric before or at 6:00 PM (PST), you get the first aggregation result at 6 PM (PST) on the day when you create the metric. If you create the metric after 6:00 PM (PST), you get the first aggregation result at 6 PM (PST) the next day. 2968 */ 2969 offset?: Offset; 2970 } 2971 export interface UntagResourceRequest { 2972 /** 2973 * The ARN of the resource to untag. 2974 */ 2975 resourceArn: AmazonResourceName; 2976 /** 2977 * A list of keys for tags to remove from the resource. 2978 */ 2979 tagKeys: TagKeyList; 2980 } 2981 export interface UntagResourceResponse { 2982 } 2983 export interface UpdateAccessPolicyRequest { 2984 /** 2985 * The ID of the access policy. 2986 */ 2987 accessPolicyId: ID; 2988 /** 2989 * The identity for this access policy. Choose an Amazon Web Services SSO user, an Amazon Web Services SSO group, or an IAM user. 2990 */ 2991 accessPolicyIdentity: Identity; 2992 /** 2993 * The IoT SiteWise Monitor resource for this access policy. Choose either a portal or a project. 2994 */ 2995 accessPolicyResource: Resource; 2996 /** 2997 * The permission level for this access policy. Note that a project ADMINISTRATOR is also known as a project owner. 2998 */ 2999 accessPolicyPermission: Permission; 3000 /** 3001 * 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. 3002 */ 3003 clientToken?: ClientToken; 3004 } 3005 export interface UpdateAccessPolicyResponse { 3006 } 3007 export interface UpdateAssetModelRequest { 3008 /** 3009 * The ID of the asset model to update. 3010 */ 3011 assetModelId: ID; 3012 /** 3013 * A unique, friendly name for the asset model. 3014 */ 3015 assetModelName: Name; 3016 /** 3017 * A description for the asset model. 3018 */ 3019 assetModelDescription?: Description; 3020 /** 3021 * The updated property definitions of the asset model. For more information, see Asset properties in the IoT SiteWise User Guide. You can specify up to 200 properties per asset model. For more information, see Quotas in the IoT SiteWise User Guide. 3022 */ 3023 assetModelProperties?: AssetModelProperties; 3024 /** 3025 * The updated hierarchy definitions of the asset model. Each hierarchy specifies an asset model whose assets can be children of any other assets created from this asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide. You can specify up to 10 hierarchies per asset model. For more information, see Quotas in the IoT SiteWise User Guide. 3026 */ 3027 assetModelHierarchies?: AssetModelHierarchies; 3028 /** 3029 * The composite asset models that are part of this asset model. Composite asset models are asset models that contain specific properties. Each composite model has a type that defines the properties that the composite model supports. Use composite asset models to define alarms on this asset model. 3030 */ 3031 assetModelCompositeModels?: AssetModelCompositeModels; 3032 /** 3033 * 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. 3034 */ 3035 clientToken?: ClientToken; 3036 } 3037 export interface UpdateAssetModelResponse { 3038 /** 3039 * The status of the asset model, which contains a state (UPDATING after successfully calling this operation) and any error message. 3040 */ 3041 assetModelStatus: AssetModelStatus; 3042 } 3043 export interface UpdateAssetPropertyRequest { 3044 /** 3045 * The ID of the asset to be updated. 3046 */ 3047 assetId: ID; 3048 /** 3049 * The ID of the asset property to be updated. 3050 */ 3051 propertyId: ID; 3052 /** 3053 * The alias that identifies the property, such as an OPC-UA server data stream path (for example, /company/windfarm/3/turbine/7/temperature). For more information, see Mapping industrial data streams to asset properties in the IoT SiteWise User Guide. If you omit this parameter, the alias is removed from the property. 3054 */ 3055 propertyAlias?: PropertyAlias; 3056 /** 3057 * The MQTT notification state (enabled or disabled) for this asset property. When the notification state is enabled, IoT SiteWise publishes property value updates to a unique MQTT topic. For more information, see Interacting with other services in the IoT SiteWise User Guide. If you omit this parameter, the notification state is set to DISABLED. 3058 */ 3059 propertyNotificationState?: PropertyNotificationState; 3060 /** 3061 * 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. 3062 */ 3063 clientToken?: ClientToken; 3064 } 3065 export interface UpdateAssetRequest { 3066 /** 3067 * The ID of the asset to update. 3068 */ 3069 assetId: ID; 3070 /** 3071 * A unique, friendly name for the asset. 3072 */ 3073 assetName: Name; 3074 /** 3075 * 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. 3076 */ 3077 clientToken?: ClientToken; 3078 } 3079 export interface UpdateAssetResponse { 3080 /** 3081 * The status of the asset, which contains a state (UPDATING after successfully calling this operation) and any error message. 3082 */ 3083 assetStatus: AssetStatus; 3084 } 3085 export interface UpdateDashboardRequest { 3086 /** 3087 * The ID of the dashboard to update. 3088 */ 3089 dashboardId: ID; 3090 /** 3091 * A new friendly name for the dashboard. 3092 */ 3093 dashboardName: Name; 3094 /** 3095 * A new description for the dashboard. 3096 */ 3097 dashboardDescription?: Description; 3098 /** 3099 * The new dashboard definition, as specified in a JSON literal. For detailed information, see Creating dashboards (CLI) in the IoT SiteWise User Guide. 3100 */ 3101 dashboardDefinition: DashboardDefinition; 3102 /** 3103 * 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. 3104 */ 3105 clientToken?: ClientToken; 3106 } 3107 export interface UpdateDashboardResponse { 3108 } 3109 export interface UpdateGatewayCapabilityConfigurationRequest { 3110 /** 3111 * The ID of the gateway to be updated. 3112 */ 3113 gatewayId: ID; 3114 /** 3115 * The namespace of the gateway capability configuration to be updated. For example, if you configure OPC-UA sources from the IoT SiteWise console, your OPC-UA capability configuration has the namespace iotsitewise:opcuacollector:version, where version is a number such as 1. 3116 */ 3117 capabilityNamespace: CapabilityNamespace; 3118 /** 3119 * The JSON document that defines the configuration for the gateway capability. For more information, see Configuring data sources (CLI) in the IoT SiteWise User Guide. 3120 */ 3121 capabilityConfiguration: CapabilityConfiguration; 3122 } 3123 export interface UpdateGatewayCapabilityConfigurationResponse { 3124 /** 3125 * The namespace of the gateway capability. 3126 */ 3127 capabilityNamespace: CapabilityNamespace; 3128 /** 3129 * The synchronization status of the capability configuration. The sync status can be one of the following: IN_SYNC – The gateway is running the capability configuration. OUT_OF_SYNC – The gateway hasn't received the capability configuration. SYNC_FAILED – The gateway rejected the capability configuration. After you update a capability configuration, its sync status is OUT_OF_SYNC until the gateway receives and applies or rejects the updated configuration. 3130 */ 3131 capabilitySyncStatus: CapabilitySyncStatus; 3132 } 3133 export interface UpdateGatewayRequest { 3134 /** 3135 * The ID of the gateway to update. 3136 */ 3137 gatewayId: ID; 3138 /** 3139 * A unique, friendly name for the gateway. 3140 */ 3141 gatewayName: Name; 3142 } 3143 export interface UpdatePortalRequest { 3144 /** 3145 * The ID of the portal to update. 3146 */ 3147 portalId: ID; 3148 /** 3149 * A new friendly name for the portal. 3150 */ 3151 portalName: Name; 3152 /** 3153 * A new description for the portal. 3154 */ 3155 portalDescription?: Description; 3156 /** 3157 * The Amazon Web Services administrator's contact email address. 3158 */ 3159 portalContactEmail: Email; 3160 portalLogoImage?: Image; 3161 /** 3162 * The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide. 3163 */ 3164 roleArn: ARN; 3165 /** 3166 * 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. 3167 */ 3168 clientToken?: ClientToken; 3169 /** 3170 * The email address that sends alarm notifications. 3171 */ 3172 notificationSenderEmail?: Email; 3173 /** 3174 * Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide. 3175 */ 3176 alarms?: Alarms; 3177 } 3178 export interface UpdatePortalResponse { 3179 /** 3180 * The status of the portal, which contains a state (UPDATING after successfully calling this operation) and any error message. 3181 */ 3182 portalStatus: PortalStatus; 3183 } 3184 export interface UpdateProjectRequest { 3185 /** 3186 * The ID of the project to update. 3187 */ 3188 projectId: ID; 3189 /** 3190 * A new friendly name for the project. 3191 */ 3192 projectName: Name; 3193 /** 3194 * A new description for the project. 3195 */ 3196 projectDescription?: Description; 3197 /** 3198 * 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. 3199 */ 3200 clientToken?: ClientToken; 3201 } 3202 export interface UpdateProjectResponse { 3203 } 3204 export type Url = string; 3205 export interface UserIdentity { 3206 /** 3207 * The Amazon Web Services SSO ID of the user. 3208 */ 3209 id: IdentityId; 3210 } 3211 export type VariableName = string; 3212 export interface VariableValue { 3213 /** 3214 * The ID of the property to use as the variable. You can use the property name if it's from the same asset model. 3215 */ 3216 propertyId: Macro; 3217 /** 3218 * The ID of the hierarchy to query for the property ID. You can use the hierarchy's name instead of the hierarchy's ID. You use a hierarchy ID instead of a model ID because you can have several hierarchies using the same model and therefore the same propertyId. For example, you might have separately grouped assets that come from the same asset model. For more information, see Asset hierarchies in the IoT SiteWise User Guide. 3219 */ 3220 hierarchyId?: Macro; 3221 } 3222 export interface Variant { 3223 /** 3224 * Asset property data of type string (sequence of characters). 3225 */ 3226 stringValue?: PropertyValueStringValue; 3227 /** 3228 * Asset property data of type integer (whole number). 3229 */ 3230 integerValue?: PropertyValueIntegerValue; 3231 /** 3232 * Asset property data of type double (floating point number). 3233 */ 3234 doubleValue?: PropertyValueDoubleValue; 3235 /** 3236 * Asset property data of type Boolean (true or false). 3237 */ 3238 booleanValue?: PropertyValueBooleanValue; 3239 } 3240 /** 3241 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 3242 */ 3243 export type apiVersion = "2019-12-02"|"latest"|string; 3244 export interface ClientApiVersions { 3245 /** 3246 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version. 3247 */ 3248 apiVersion?: apiVersion; 3249 } 3250 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions; 3251 /** 3252 * Contains interfaces for use with the IoTSiteWise client. 3253 */ 3254 export import Types = IoTSiteWise; 3255 } 3256 export = IoTSiteWise;