* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.iotsitewise.AbstractAWSIoTSiteWise} instead. *
**
* Welcome to the IoT SiteWise API Reference. IoT SiteWise is an Amazon Web Services service that connects Industrial Internet of Things * (IIoT) devices to the power of the Amazon Web Services Cloud. For more information, see the IoT SiteWise User Guide. For information about * IoT SiteWise quotas, see Quotas * in the IoT SiteWise User Guide. *
*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSIoTSiteWise { /** * The region metadata service name for computing region endpoints. You can use this value to retrieve metadata * (such as supported regions) of the service. * * @see RegionUtils#getRegionsForService(String) */ String ENDPOINT_PREFIX = "iotsitewise"; /** ** 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. *
* * @param associateAssetsRequest * @return Result of the AssociateAssets operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceAlreadyExistsException * The resource already exists. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws LimitExceededException * You've reached the limit for a resource. For example, this can occur if you're trying to associate more * than the allowed number of child assets or attempting to create more than the allowed number of * properties for an asset model. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.AssociateAssets * @see AWS * API Documentation */ AssociateAssetsResult associateAssets(AssociateAssetsRequest associateAssetsRequest); /** *
* Associates a time series (data stream) with an asset property. *
* * @param associateTimeSeriesToAssetPropertyRequest * @return Result of the AssociateTimeSeriesToAssetProperty operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.AssociateTimeSeriesToAssetProperty * @see AWS API Documentation */ AssociateTimeSeriesToAssetPropertyResult associateTimeSeriesToAssetProperty( AssociateTimeSeriesToAssetPropertyRequest associateTimeSeriesToAssetPropertyRequest); /** *
* Associates a group (batch) of assets with an IoT SiteWise Monitor project. *
* * @param batchAssociateProjectAssetsRequest * @return Result of the BatchAssociateProjectAssets operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws LimitExceededException * You've reached the limit for a resource. For example, this can occur if you're trying to associate more * than the allowed number of child assets or attempting to create more than the allowed number of * properties for an asset model. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.BatchAssociateProjectAssets * @see AWS API Documentation */ BatchAssociateProjectAssetsResult batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest batchAssociateProjectAssetsRequest); /** *
* Disassociates a group (batch) of assets from an IoT SiteWise Monitor project. *
* * @param batchDisassociateProjectAssetsRequest * @return Result of the BatchDisassociateProjectAssets operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.BatchDisassociateProjectAssets * @see AWS API Documentation */ BatchDisassociateProjectAssetsResult batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest batchDisassociateProjectAssetsRequest); /** *
* Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties. For more * information, see Querying * aggregates in the IoT SiteWise User Guide. *
* * @param batchGetAssetPropertyAggregatesRequest * @return Result of the BatchGetAssetPropertyAggregates operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ServiceUnavailableException * The requested service is unavailable. * @sample AWSIoTSiteWise.BatchGetAssetPropertyAggregates * @see AWS API Documentation */ BatchGetAssetPropertyAggregatesResult batchGetAssetPropertyAggregates(BatchGetAssetPropertyAggregatesRequest batchGetAssetPropertyAggregatesRequest); /** *
* Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide. *
* * @param batchGetAssetPropertyValueRequest * @return Result of the BatchGetAssetPropertyValue operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ServiceUnavailableException * The requested service is unavailable. * @sample AWSIoTSiteWise.BatchGetAssetPropertyValue * @see AWS API Documentation */ BatchGetAssetPropertyValueResult batchGetAssetPropertyValue(BatchGetAssetPropertyValueRequest batchGetAssetPropertyValueRequest); /** *
* Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide. *
* * @param batchGetAssetPropertyValueHistoryRequest * @return Result of the BatchGetAssetPropertyValueHistory operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ServiceUnavailableException * The requested service is unavailable. * @sample AWSIoTSiteWise.BatchGetAssetPropertyValueHistory * @see AWS API Documentation */ BatchGetAssetPropertyValueHistoryResult batchGetAssetPropertyValueHistory(BatchGetAssetPropertyValueHistoryRequest batchGetAssetPropertyValueHistoryRequest); /** *
* 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.
*
* For more information, see Quotas in the IoT * SiteWise User Guide. * @throws LimitExceededException * You've reached the limit for a resource. For example, this can occur if you're trying to associate more * than the allowed number of child assets or attempting to create more than the allowed number of * properties for an asset model. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ServiceUnavailableException * The requested service is unavailable. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.BatchPutAssetPropertyValue * @see AWS API Documentation */ BatchPutAssetPropertyValueResult batchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest batchPutAssetPropertyValueRequest); /** *
* Creates an access policy that grants the specified identity (IAM Identity Center user, IAM Identity Center group, * or IAM user) access to the specified IoT SiteWise Monitor portal or project resource. *
* * @param createAccessPolicyRequest * @return Result of the CreateAccessPolicy operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws LimitExceededException * You've reached the limit for a resource. For example, this can occur if you're trying to associate more * than the allowed number of child assets or attempting to create more than the allowed number of * properties for an asset model. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.CreateAccessPolicy * @see AWS * API Documentation */ CreateAccessPolicyResult createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest); /** *
* Creates an asset from an existing asset model. For more information, see Creating assets in the * IoT SiteWise User Guide. *
* * @param createAssetRequest * @return Result of the CreateAsset operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceAlreadyExistsException * The resource already exists. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws LimitExceededException * You've reached the limit for a resource. For example, this can occur if you're trying to associate more * than the allowed number of child assets or attempting to create more than the allowed number of * properties for an asset model. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.CreateAsset * @see AWS API * Documentation */ CreateAssetResult createAsset(CreateAssetRequest createAssetRequest); /** *
* 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. *
* * @param createAssetModelRequest * @return Result of the CreateAssetModel operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceAlreadyExistsException * The resource already exists. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws LimitExceededException * You've reached the limit for a resource. For example, this can occur if you're trying to associate more * than the allowed number of child assets or attempting to create more than the allowed number of * properties for an asset model. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.CreateAssetModel * @see AWS * API Documentation */ CreateAssetModelResult createAssetModel(CreateAssetModelRequest createAssetModelRequest); /** *
* Defines a job to ingest data to IoT SiteWise from Amazon S3. For more information, see Create a bulk import * job (CLI) in the Amazon Simple Storage Service User Guide. *
** You must enable IoT SiteWise to export data to Amazon S3 before you create a bulk import job. For more * information about how to configure storage settings, see PutStorageConfiguration. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws LimitExceededException * You've reached the limit for a resource. For example, this can occur if you're trying to associate more * than the allowed number of child assets or attempting to create more than the allowed number of * properties for an asset model. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.CreateBulkImportJob * @see AWS API Documentation */ CreateBulkImportJobResult createBulkImportJob(CreateBulkImportJobRequest createBulkImportJobRequest); /** *
* Creates a dashboard in an IoT SiteWise Monitor project. *
* * @param createDashboardRequest * @return Result of the CreateDashboard operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws LimitExceededException * You've reached the limit for a resource. For example, this can occur if you're trying to associate more * than the allowed number of child assets or attempting to create more than the allowed number of * properties for an asset model. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.CreateDashboard * @see AWS * API Documentation */ CreateDashboardResult createDashboard(CreateDashboardRequest createDashboardRequest); /** *
* 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. *
* * @param createGatewayRequest * @return Result of the CreateGateway operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceAlreadyExistsException * The resource already exists. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws LimitExceededException * You've reached the limit for a resource. For example, this can occur if you're trying to associate more * than the allowed number of child assets or attempting to create more than the allowed number of * properties for an asset model. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.CreateGateway * @see AWS API * Documentation */ CreateGatewayResult createGateway(CreateGatewayRequest createGatewayRequest); /** *
* Creates a portal, which can contain projects and dashboards. IoT SiteWise Monitor uses IAM Identity Center 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. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws LimitExceededException * You've reached the limit for a resource. For example, this can occur if you're trying to associate more * than the allowed number of child assets or attempting to create more than the allowed number of * properties for an asset model. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.CreatePortal * @see AWS API * Documentation */ CreatePortalResult createPortal(CreatePortalRequest createPortalRequest); /** *
* Creates a project in the specified portal. *
** Make sure that the project name and description don't contain confidential information. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws LimitExceededException * You've reached the limit for a resource. For example, this can occur if you're trying to associate more * than the allowed number of child assets or attempting to create more than the allowed number of * properties for an asset model. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.CreateProject * @see AWS API * Documentation */ CreateProjectResult createProject(CreateProjectRequest createProjectRequest); /** *
* 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. *
* * @param deleteAccessPolicyRequest * @return Result of the DeleteAccessPolicy operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.DeleteAccessPolicy * @see AWS * API Documentation */ DeleteAccessPolicyResult deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest); /** *
* 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. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.DeleteAsset * @see AWS API * Documentation */ DeleteAssetResult deleteAsset(DeleteAssetRequest deleteAssetRequest); /** *
* 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. *
* * @param deleteAssetModelRequest * @return Result of the DeleteAssetModel operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.DeleteAssetModel * @see AWS * API Documentation */ DeleteAssetModelResult deleteAssetModel(DeleteAssetModelRequest deleteAssetModelRequest); /** *
* Deletes a dashboard from IoT SiteWise Monitor. *
* * @param deleteDashboardRequest * @return Result of the DeleteDashboard operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.DeleteDashboard * @see AWS * API Documentation */ DeleteDashboardResult deleteDashboard(DeleteDashboardRequest deleteDashboardRequest); /** *
* Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your * gateway's file system. *
* * @param deleteGatewayRequest * @return Result of the DeleteGateway operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.DeleteGateway * @see AWS API * Documentation */ DeleteGatewayResult deleteGateway(DeleteGatewayRequest deleteGatewayRequest); /** *
* Deletes a portal from IoT SiteWise Monitor. *
* * @param deletePortalRequest * @return Result of the DeletePortal operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.DeletePortal * @see AWS API * Documentation */ DeletePortalResult deletePortal(DeletePortalRequest deletePortalRequest); /** *
* Deletes a project from IoT SiteWise Monitor. *
* * @param deleteProjectRequest * @return Result of the DeleteProject operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.DeleteProject * @see AWS API * Documentation */ DeleteProjectResult deleteProject(DeleteProjectRequest deleteProjectRequest); /** *
* Deletes a time series (data stream). If you delete a time series that's associated with an asset property, the * asset property still exists, but the time series will no longer be associated with this asset property. *
** To identify a time series, do one of the following: *
*
* If the time series isn't associated with an asset property, specify the alias of the time series.
*
* If the time series is associated with an asset property, specify one of the following: *
*
* The alias of the time series.
*
* The assetId and propertyId that identifies the asset property.
*
* For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.DeleteTimeSeries * @see AWS * API Documentation */ DeleteTimeSeriesResult deleteTimeSeries(DeleteTimeSeriesRequest deleteTimeSeriesRequest); /** *
* Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project. *
* * @param describeAccessPolicyRequest * @return Result of the DescribeAccessPolicy operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.DescribeAccessPolicy * @see AWS API Documentation */ DescribeAccessPolicyResult describeAccessPolicy(DescribeAccessPolicyRequest describeAccessPolicyRequest); /** *
* Retrieves information about an asset. *
* * @param describeAssetRequest * @return Result of the DescribeAsset operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.DescribeAsset * @see AWS API * Documentation */ DescribeAssetResult describeAsset(DescribeAssetRequest describeAssetRequest); /** *
* Retrieves information about an asset model. *
* * @param describeAssetModelRequest * @return Result of the DescribeAssetModel operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.DescribeAssetModel * @see AWS * API Documentation */ DescribeAssetModelResult describeAssetModel(DescribeAssetModelRequest describeAssetModelRequest); /** *
* 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. *
* * @param describeAssetPropertyRequest * @return Result of the DescribeAssetProperty operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.DescribeAssetProperty * @see AWS API Documentation */ DescribeAssetPropertyResult describeAssetProperty(DescribeAssetPropertyRequest describeAssetPropertyRequest); /** *
* Retrieves information about a bulk import job request. For more information, see Describe a bulk * import job (CLI) in the Amazon Simple Storage Service User Guide. *
* * @param describeBulkImportJobRequest * @return Result of the DescribeBulkImportJob operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.DescribeBulkImportJob * @see AWS API Documentation */ DescribeBulkImportJobResult describeBulkImportJob(DescribeBulkImportJobRequest describeBulkImportJobRequest); /** *
* Retrieves information about a dashboard. *
* * @param describeDashboardRequest * @return Result of the DescribeDashboard operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.DescribeDashboard * @see AWS * API Documentation */ DescribeDashboardResult describeDashboard(DescribeDashboardRequest describeDashboardRequest); /** *
* 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. *
* * @param describeDefaultEncryptionConfigurationRequest * @return Result of the DescribeDefaultEncryptionConfiguration operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.DescribeDefaultEncryptionConfiguration * @see AWS API Documentation */ DescribeDefaultEncryptionConfigurationResult describeDefaultEncryptionConfiguration( DescribeDefaultEncryptionConfigurationRequest describeDefaultEncryptionConfigurationRequest); /** *
* Retrieves information about a gateway. *
* * @param describeGatewayRequest * @return Result of the DescribeGateway operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.DescribeGateway * @see AWS * API Documentation */ DescribeGatewayResult describeGateway(DescribeGatewayRequest describeGatewayRequest); /** *
* 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. *
* * @param describeGatewayCapabilityConfigurationRequest * @return Result of the DescribeGatewayCapabilityConfiguration operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.DescribeGatewayCapabilityConfiguration * @see AWS API Documentation */ DescribeGatewayCapabilityConfigurationResult describeGatewayCapabilityConfiguration( DescribeGatewayCapabilityConfigurationRequest describeGatewayCapabilityConfigurationRequest); /** *
* Retrieves the current IoT SiteWise logging options. *
* * @param describeLoggingOptionsRequest * @return Result of the DescribeLoggingOptions operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ResourceNotFoundException * The requested resource can't be found. * @sample AWSIoTSiteWise.DescribeLoggingOptions * @see AWS API Documentation */ DescribeLoggingOptionsResult describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest); /** *
* Retrieves information about a portal. *
* * @param describePortalRequest * @return Result of the DescribePortal operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.DescribePortal * @see AWS API * Documentation */ DescribePortalResult describePortal(DescribePortalRequest describePortalRequest); /** *
* Retrieves information about a project. *
* * @param describeProjectRequest * @return Result of the DescribeProject operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.DescribeProject * @see AWS * API Documentation */ DescribeProjectResult describeProject(DescribeProjectRequest describeProjectRequest); /** *
* Retrieves information about the storage configuration for IoT SiteWise. *
* * @param describeStorageConfigurationRequest * @return Result of the DescribeStorageConfiguration operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws LimitExceededException * You've reached the limit for a resource. For example, this can occur if you're trying to associate more * than the allowed number of child assets or attempting to create more than the allowed number of * properties for an asset model. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.DescribeStorageConfiguration * @see AWS API Documentation */ DescribeStorageConfigurationResult describeStorageConfiguration(DescribeStorageConfigurationRequest describeStorageConfigurationRequest); /** *
* Retrieves information about a time series (data stream). *
** To identify a time series, do one of the following: *
*
* If the time series isn't associated with an asset property, specify the alias of the time series.
*
* If the time series is associated with an asset property, specify one of the following: *
*
* The alias of the time series.
*
* The assetId and propertyId that identifies the asset property.
*
* For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.DescribeTimeSeries * @see AWS * API Documentation */ DescribeTimeSeriesResult describeTimeSeries(DescribeTimeSeriesRequest describeTimeSeriesRequest); /** *
* Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model. *
* * @param disassociateAssetsRequest * @return Result of the DisassociateAssets operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.DisassociateAssets * @see AWS * API Documentation */ DisassociateAssetsResult disassociateAssets(DisassociateAssetsRequest disassociateAssetsRequest); /** *
* Disassociates a time series (data stream) from an asset property. *
* * @param disassociateTimeSeriesFromAssetPropertyRequest * @return Result of the DisassociateTimeSeriesFromAssetProperty operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.DisassociateTimeSeriesFromAssetProperty * @see AWS API Documentation */ DisassociateTimeSeriesFromAssetPropertyResult disassociateTimeSeriesFromAssetProperty( DisassociateTimeSeriesFromAssetPropertyRequest disassociateTimeSeriesFromAssetPropertyRequest); /** *
* 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.
*
* For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ServiceUnavailableException * The requested service is unavailable. * @sample AWSIoTSiteWise.GetAssetPropertyAggregates * @see AWS API Documentation */ GetAssetPropertyAggregatesResult getAssetPropertyAggregates(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest); /** *
* 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.
*
* For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ServiceUnavailableException * The requested service is unavailable. * @sample AWSIoTSiteWise.GetAssetPropertyValue * @see AWS API Documentation */ GetAssetPropertyValueResult getAssetPropertyValue(GetAssetPropertyValueRequest getAssetPropertyValueRequest); /** *
* 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.
*
* For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ServiceUnavailableException * The requested service is unavailable. * @sample AWSIoTSiteWise.GetAssetPropertyValueHistory * @see AWS API Documentation */ GetAssetPropertyValueHistoryResult getAssetPropertyValueHistory(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest); /** *
* 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.
*
* For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ServiceUnavailableException * The requested service is unavailable. * @sample AWSIoTSiteWise.GetInterpolatedAssetPropertyValues * @see AWS API Documentation */ GetInterpolatedAssetPropertyValuesResult getInterpolatedAssetPropertyValues( GetInterpolatedAssetPropertyValuesRequest getInterpolatedAssetPropertyValuesRequest); /** *
* Retrieves a paginated list of access policies for an identity (an IAM Identity Center user, an IAM Identity * Center group, or an IAM user) or an IoT SiteWise Monitor resource (a portal or project). *
* * @param listAccessPoliciesRequest * @return Result of the ListAccessPolicies operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.ListAccessPolicies * @see AWS * API Documentation */ ListAccessPoliciesResult listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest); /** *
* Retrieves a paginated list of properties associated with an asset model. If you update properties associated with * the model before you finish listing all the properties, you need to start all over again. *
* * @param listAssetModelPropertiesRequest * @return Result of the ListAssetModelProperties operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.ListAssetModelProperties * @see AWS API Documentation */ ListAssetModelPropertiesResult listAssetModelProperties(ListAssetModelPropertiesRequest listAssetModelPropertiesRequest); /** *
* Retrieves a paginated list of summaries of all asset models. *
* * @param listAssetModelsRequest * @return Result of the ListAssetModels operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.ListAssetModels * @see AWS * API Documentation */ ListAssetModelsResult listAssetModels(ListAssetModelsRequest listAssetModelsRequest); /** *
* Retrieves a paginated list of properties associated with an asset. If you update properties associated with the * model before you finish listing all the properties, you need to start all over again. *
* * @param listAssetPropertiesRequest * @return Result of the ListAssetProperties operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.ListAssetProperties * @see AWS API Documentation */ ListAssetPropertiesResult listAssetProperties(ListAssetPropertiesRequest listAssetPropertiesRequest); /** *
* 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. *
* * @param listAssetRelationshipsRequest * @return Result of the ListAssetRelationships operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.ListAssetRelationships * @see AWS API Documentation */ ListAssetRelationshipsResult listAssetRelationships(ListAssetRelationshipsRequest listAssetRelationshipsRequest); /** *
* 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. *
* * @param listAssetsRequest * @return Result of the ListAssets operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.ListAssets * @see AWS API * Documentation */ ListAssetsResult listAssets(ListAssetsRequest listAssetsRequest); /** *
* 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. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.ListAssociatedAssets * @see AWS API Documentation */ ListAssociatedAssetsResult listAssociatedAssets(ListAssociatedAssetsRequest listAssociatedAssetsRequest); /** *
* Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs * (CLI) in the IoT SiteWise User Guide. *
* * @param listBulkImportJobsRequest * @return Result of the ListBulkImportJobs operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.ListBulkImportJobs * @see AWS * API Documentation */ ListBulkImportJobsResult listBulkImportJobs(ListBulkImportJobsRequest listBulkImportJobsRequest); /** *
* Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project. *
* * @param listDashboardsRequest * @return Result of the ListDashboards operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.ListDashboards * @see AWS API * Documentation */ ListDashboardsResult listDashboards(ListDashboardsRequest listDashboardsRequest); /** *
* Retrieves a paginated list of gateways. *
* * @param listGatewaysRequest * @return Result of the ListGateways operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.ListGateways * @see AWS API * Documentation */ ListGatewaysResult listGateways(ListGatewaysRequest listGatewaysRequest); /** *
* Retrieves a paginated list of IoT SiteWise Monitor portals. *
* * @param listPortalsRequest * @return Result of the ListPortals operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.ListPortals * @see AWS API * Documentation */ ListPortalsResult listPortals(ListPortalsRequest listPortalsRequest); /** *
* Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project. *
* * @param listProjectAssetsRequest * @return Result of the ListProjectAssets operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.ListProjectAssets * @see AWS * API Documentation */ ListProjectAssetsResult listProjectAssets(ListProjectAssetsRequest listProjectAssetsRequest); /** *
* Retrieves a paginated list of projects for an IoT SiteWise Monitor portal. *
* * @param listProjectsRequest * @return Result of the ListProjects operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.ListProjects * @see AWS API * Documentation */ ListProjectsResult listProjects(ListProjectsRequest listProjectsRequest); /** *
* Retrieves the list of tags for an IoT SiteWise resource. *
* * @param listTagsForResourceRequest * @return Result of the ListTagsForResource operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @throws LimitExceededException * You've reached the limit for a resource. For example, this can occur if you're trying to associate more * than the allowed number of child assets or attempting to create more than the allowed number of * properties for an asset model. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws UnauthorizedException * You are not authorized. * @sample AWSIoTSiteWise.ListTagsForResource * @see AWS API Documentation */ ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest); /** *
* Retrieves a paginated list of time series (data streams). *
* * @param listTimeSeriesRequest * @return Result of the ListTimeSeries operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.ListTimeSeries * @see AWS API * Documentation */ ListTimeSeriesResult listTimeSeries(ListTimeSeriesRequest listTimeSeriesRequest); /** *
* Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the * IoT SiteWise User Guide. *
* * @param putDefaultEncryptionConfigurationRequest * @return Result of the PutDefaultEncryptionConfiguration operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws LimitExceededException * You've reached the limit for a resource. For example, this can occur if you're trying to associate more * than the allowed number of child assets or attempting to create more than the allowed number of * properties for an asset model. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.PutDefaultEncryptionConfiguration * @see AWS API Documentation */ PutDefaultEncryptionConfigurationResult putDefaultEncryptionConfiguration(PutDefaultEncryptionConfigurationRequest putDefaultEncryptionConfigurationRequest); /** *
* Sets logging options for IoT SiteWise. *
* * @param putLoggingOptionsRequest * @return Result of the PutLoggingOptions operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @throws ResourceNotFoundException * The requested resource can't be found. * @sample AWSIoTSiteWise.PutLoggingOptions * @see AWS * API Documentation */ PutLoggingOptionsResult putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest); /** *
* Configures storage settings for IoT SiteWise. *
* * @param putStorageConfigurationRequest * @return Result of the PutStorageConfiguration operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceAlreadyExistsException * The resource already exists. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws LimitExceededException * You've reached the limit for a resource. For example, this can occur if you're trying to associate more * than the allowed number of child assets or attempting to create more than the allowed number of * properties for an asset model. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.PutStorageConfiguration * @see AWS API Documentation */ PutStorageConfigurationResult putStorageConfiguration(PutStorageConfigurationRequest putStorageConfigurationRequest); /** *
* Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's * value. *
* * @param tagResourceRequest * @return Result of the TagResource operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @throws LimitExceededException * You've reached the limit for a resource. For example, this can occur if you're trying to associate more * than the allowed number of child assets or attempting to create more than the allowed number of * properties for an asset model. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws UnauthorizedException * You are not authorized. * @throws TooManyTagsException * You've reached the limit for the number of tags allowed for a resource. For more information, see Tag naming limits * and requirements in the Amazon Web Services General Reference. * @sample AWSIoTSiteWise.TagResource * @see AWS API * Documentation */ TagResourceResult tagResource(TagResourceRequest tagResourceRequest); /** *
* Removes a tag from an IoT SiteWise resource. *
* * @param untagResourceRequest * @return Result of the UntagResource operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @throws LimitExceededException * You've reached the limit for a resource. For example, this can occur if you're trying to associate more * than the allowed number of child assets or attempting to create more than the allowed number of * properties for an asset model. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws UnauthorizedException * You are not authorized. * @sample AWSIoTSiteWise.UntagResource * @see AWS API * Documentation */ UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest); /** *
* Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or * project resource. *
* * @param updateAccessPolicyRequest * @return Result of the UpdateAccessPolicy operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.UpdateAccessPolicy * @see AWS * API Documentation */ UpdateAccessPolicyResult updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest); /** *
* Updates an asset's name. For more information, see Updating assets * and models in the IoT SiteWise User Guide. *
* * @param updateAssetRequest * @return Result of the UpdateAsset operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceAlreadyExistsException * The resource already exists. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.UpdateAsset * @see AWS API * Documentation */ UpdateAssetResult updateAsset(UpdateAssetRequest updateAssetRequest); /** *
* 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. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.UpdateAssetModel * @see AWS * API Documentation */ UpdateAssetModelResult updateAssetModel(UpdateAssetModelRequest updateAssetModelRequest); /** *
* 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. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.UpdateAssetProperty * @see AWS API Documentation */ UpdateAssetPropertyResult updateAssetProperty(UpdateAssetPropertyRequest updateAssetPropertyRequest); /** *
* Updates an IoT SiteWise Monitor dashboard. *
* * @param updateDashboardRequest * @return Result of the UpdateDashboard operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.UpdateDashboard * @see AWS * API Documentation */ UpdateDashboardResult updateDashboard(UpdateDashboardRequest updateDashboardRequest); /** *
* Updates a gateway's name. *
* * @param updateGatewayRequest * @return Result of the UpdateGateway operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.UpdateGateway * @see AWS API * Documentation */ UpdateGatewayResult updateGateway(UpdateGatewayRequest updateGatewayRequest); /** *
* 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. *
* * @param updateGatewayCapabilityConfigurationRequest * @return Result of the UpdateGatewayCapabilityConfiguration operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws LimitExceededException * You've reached the limit for a resource. For example, this can occur if you're trying to associate more * than the allowed number of child assets or attempting to create more than the allowed number of * properties for an asset model. *
** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.UpdateGatewayCapabilityConfiguration * @see AWS API Documentation */ UpdateGatewayCapabilityConfigurationResult updateGatewayCapabilityConfiguration( UpdateGatewayCapabilityConfigurationRequest updateGatewayCapabilityConfigurationRequest); /** *
* Updates an IoT SiteWise Monitor portal. *
* * @param updatePortalRequest * @return Result of the UpdatePortal operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @throws ConflictingOperationException * Your request has conflicting operations. This can occur if you're trying to perform more than one * operation on the same resource at the same time. * @sample AWSIoTSiteWise.UpdatePortal * @see AWS API * Documentation */ UpdatePortalResult updatePortal(UpdatePortalRequest updatePortalRequest); /** *
* Updates an IoT SiteWise Monitor project. *
* * @param updateProjectRequest * @return Result of the UpdateProject operation returned by the service. * @throws InvalidRequestException * The request isn't valid. This can occur if your request contains malformed JSON or unsupported * characters. Check your request and try again. * @throws ResourceNotFoundException * The requested resource can't be found. * @throws InternalFailureException * IoT SiteWise can't process your request right now. Try again later. * @throws ThrottlingException * Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise * assets that can be created per second, the allowed number of messages per second, and so on. ** For more information, see Quotas in the IoT * SiteWise User Guide. * @sample AWSIoTSiteWise.UpdateProject * @see AWS API * Documentation */ UpdateProjectResult updateProject(UpdateProjectRequest updateProjectRequest); /** * Shuts down this client object, releasing any resources that might be held open. This is an optional method, and * callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client * has been shutdown, it should not be used to make any more requests. */ void shutdown(); /** * Returns additional metadata for a previously executed successful request, typically used for debugging issues * where a service isn't acting as expected. This data isn't considered part of the result data returned by an * operation, so it's available through this separate, diagnostic interface. *
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic * information for an executed request, you should use this method to retrieve it as soon as possible after * executing a request. * * @param request * The originally executed request. * * @return The response metadata for the specified request, or null if none is available. */ ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); AWSIoTSiteWiseWaiters waiters(); }