AbstractAWSIoTSiteWise (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iotsitewise.AbstractAWSIoTSiteWise

All Implemented Interfaces:

AWSIoTSiteWise

Direct Known Subclasses:

AbstractAWSIoTSiteWiseAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSIoTSiteWise
extends Object
implements AWSIoTSiteWise
```
Abstract implementation of AWSIoTSiteWise. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.iotsitewise.AWSIoTSiteWise
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AssociateAssetsResult`	`associateAssets(AssociateAssetsRequest request)` Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model.
`AssociateTimeSeriesToAssetPropertyResult`	`associateTimeSeriesToAssetProperty(AssociateTimeSeriesToAssetPropertyRequest request)` Associates a time series (data stream) with an asset property.
`BatchAssociateProjectAssetsResult`	`batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest request)` Associates a group (batch) of assets with an IoT SiteWise Monitor project.
`BatchDisassociateProjectAssetsResult`	`batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest request)` Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
`BatchGetAssetPropertyAggregatesResult`	`batchGetAssetPropertyAggregates(BatchGetAssetPropertyAggregatesRequest request)` Gets aggregated values (for example, average, minimum, and maximum) for one or more asset properties.
`BatchGetAssetPropertyValueResult`	`batchGetAssetPropertyValue(BatchGetAssetPropertyValueRequest request)` Gets the current value for one or more asset properties.
`BatchGetAssetPropertyValueHistoryResult`	`batchGetAssetPropertyValueHistory(BatchGetAssetPropertyValueHistoryRequest request)` Gets the historical values for one or more asset properties.
`BatchPutAssetPropertyValueResult`	`batchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest request)` Sends a list of asset property values to IoT SiteWise.
`CreateAccessPolicyResult`	`createAccessPolicy(CreateAccessPolicyRequest request)` 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.
`CreateAssetResult`	`createAsset(CreateAssetRequest request)` Creates an asset from an existing asset model.
`CreateAssetModelResult`	`createAssetModel(CreateAssetModelRequest request)` Creates an asset model from specified property and hierarchy definitions.
`CreateBulkImportJobResult`	`createBulkImportJob(CreateBulkImportJobRequest request)` Defines a job to ingest data to IoT SiteWise from Amazon S3.
`CreateDashboardResult`	`createDashboard(CreateDashboardRequest request)` Creates a dashboard in an IoT SiteWise Monitor project.
`CreateGatewayResult`	`createGateway(CreateGatewayRequest request)` Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise.
`CreatePortalResult`	`createPortal(CreatePortalRequest request)` Creates a portal, which can contain projects and dashboards.
`CreateProjectResult`	`createProject(CreateProjectRequest request)` Creates a project in the specified portal.
`DeleteAccessPolicyResult`	`deleteAccessPolicy(DeleteAccessPolicyRequest request)` Deletes an access policy that grants the specified identity access to the specified IoT SiteWise Monitor resource.
`DeleteAssetResult`	`deleteAsset(DeleteAssetRequest request)` Deletes an asset.
`DeleteAssetModelResult`	`deleteAssetModel(DeleteAssetModelRequest request)` Deletes an asset model.
`DeleteDashboardResult`	`deleteDashboard(DeleteDashboardRequest request)` Deletes a dashboard from IoT SiteWise Monitor.
`DeleteGatewayResult`	`deleteGateway(DeleteGatewayRequest request)` Deletes a gateway from IoT SiteWise.
`DeletePortalResult`	`deletePortal(DeletePortalRequest request)` Deletes a portal from IoT SiteWise Monitor.
`DeleteProjectResult`	`deleteProject(DeleteProjectRequest request)` Deletes a project from IoT SiteWise Monitor.
`DeleteTimeSeriesResult`	`deleteTimeSeries(DeleteTimeSeriesRequest request)` Deletes a time series (data stream).
`DescribeAccessPolicyResult`	`describeAccessPolicy(DescribeAccessPolicyRequest request)` Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
`DescribeAssetResult`	`describeAsset(DescribeAssetRequest request)` Retrieves information about an asset.
`DescribeAssetModelResult`	`describeAssetModel(DescribeAssetModelRequest request)` Retrieves information about an asset model.
`DescribeAssetPropertyResult`	`describeAssetProperty(DescribeAssetPropertyRequest request)` Retrieves information about an asset property.
`DescribeBulkImportJobResult`	`describeBulkImportJob(DescribeBulkImportJobRequest request)` Retrieves information about a bulk import job request.
`DescribeDashboardResult`	`describeDashboard(DescribeDashboardRequest request)` Retrieves information about a dashboard.
`DescribeDefaultEncryptionConfigurationResult`	`describeDefaultEncryptionConfiguration(DescribeDefaultEncryptionConfigurationRequest request)` Retrieves information about the default encryption configuration for the Amazon Web Services account in the default or specified Region.
`DescribeGatewayResult`	`describeGateway(DescribeGatewayRequest request)` Retrieves information about a gateway.
`DescribeGatewayCapabilityConfigurationResult`	`describeGatewayCapabilityConfiguration(DescribeGatewayCapabilityConfigurationRequest request)` Retrieves information about a gateway capability configuration.
`DescribeLoggingOptionsResult`	`describeLoggingOptions(DescribeLoggingOptionsRequest request)` Retrieves the current IoT SiteWise logging options.
`DescribePortalResult`	`describePortal(DescribePortalRequest request)` Retrieves information about a portal.
`DescribeProjectResult`	`describeProject(DescribeProjectRequest request)` Retrieves information about a project.
`DescribeStorageConfigurationResult`	`describeStorageConfiguration(DescribeStorageConfigurationRequest request)` Retrieves information about the storage configuration for IoT SiteWise.
`DescribeTimeSeriesResult`	`describeTimeSeries(DescribeTimeSeriesRequest request)` Retrieves information about a time series (data stream).
`DisassociateAssetsResult`	`disassociateAssets(DisassociateAssetsRequest request)` Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
`DisassociateTimeSeriesFromAssetPropertyResult`	`disassociateTimeSeriesFromAssetProperty(DisassociateTimeSeriesFromAssetPropertyRequest request)` Disassociates a time series (data stream) from an asset property.
`GetAssetPropertyAggregatesResult`	`getAssetPropertyAggregates(GetAssetPropertyAggregatesRequest request)` Gets aggregated values for an asset property.
`GetAssetPropertyValueResult`	`getAssetPropertyValue(GetAssetPropertyValueRequest request)` Gets an asset property's current value.
`GetAssetPropertyValueHistoryResult`	`getAssetPropertyValueHistory(GetAssetPropertyValueHistoryRequest request)` Gets the history of an asset property's values.
`ResponseMetadata`	`getCachedResponseMetadata(AmazonWebServiceRequest request)` Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
`GetInterpolatedAssetPropertyValuesResult`	`getInterpolatedAssetPropertyValues(GetInterpolatedAssetPropertyValuesRequest request)` Get interpolated values for an asset property for a specified time interval, during a period of time.
`ListAccessPoliciesResult`	`listAccessPolicies(ListAccessPoliciesRequest request)` 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).
`ListAssetModelPropertiesResult`	`listAssetModelProperties(ListAssetModelPropertiesRequest request)` Retrieves a paginated list of properties associated with an asset model.
`ListAssetModelsResult`	`listAssetModels(ListAssetModelsRequest request)` Retrieves a paginated list of summaries of all asset models.
`ListAssetPropertiesResult`	`listAssetProperties(ListAssetPropertiesRequest request)` Retrieves a paginated list of properties associated with an asset.
`ListAssetRelationshipsResult`	`listAssetRelationships(ListAssetRelationshipsRequest request)` Retrieves a paginated list of asset relationships for an asset.
`ListAssetsResult`	`listAssets(ListAssetsRequest request)` Retrieves a paginated list of asset summaries.
`ListAssociatedAssetsResult`	`listAssociatedAssets(ListAssociatedAssetsRequest request)` Retrieves a paginated list of associated assets.
`ListBulkImportJobsResult`	`listBulkImportJobs(ListBulkImportJobsRequest request)` Retrieves a paginated list of bulk import job requests.
`ListDashboardsResult`	`listDashboards(ListDashboardsRequest request)` Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
`ListGatewaysResult`	`listGateways(ListGatewaysRequest request)` Retrieves a paginated list of gateways.
`ListPortalsResult`	`listPortals(ListPortalsRequest request)` Retrieves a paginated list of IoT SiteWise Monitor portals.
`ListProjectAssetsResult`	`listProjectAssets(ListProjectAssetsRequest request)` Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
`ListProjectsResult`	`listProjects(ListProjectsRequest request)` Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest request)` Retrieves the list of tags for an IoT SiteWise resource.
`ListTimeSeriesResult`	`listTimeSeries(ListTimeSeriesRequest request)` Retrieves a paginated list of time series (data streams).
`PutDefaultEncryptionConfigurationResult`	`putDefaultEncryptionConfiguration(PutDefaultEncryptionConfigurationRequest request)` Sets the default encryption configuration for the Amazon Web Services account.
`PutLoggingOptionsResult`	`putLoggingOptions(PutLoggingOptionsRequest request)` Sets logging options for IoT SiteWise.
`PutStorageConfigurationResult`	`putStorageConfiguration(PutStorageConfigurationRequest request)` Configures storage settings for IoT SiteWise.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest request)` Adds tags to an IoT SiteWise resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest request)` Removes a tag from an IoT SiteWise resource.
`UpdateAccessPolicyResult`	`updateAccessPolicy(UpdateAccessPolicyRequest request)` Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
`UpdateAssetResult`	`updateAsset(UpdateAssetRequest request)` Updates an asset's name.
`UpdateAssetModelResult`	`updateAssetModel(UpdateAssetModelRequest request)` Updates an asset model and all of the assets that were created from the model.
`UpdateAssetPropertyResult`	`updateAssetProperty(UpdateAssetPropertyRequest request)` Updates an asset property's alias and notification state.
`UpdateDashboardResult`	`updateDashboard(UpdateDashboardRequest request)` Updates an IoT SiteWise Monitor dashboard.
`UpdateGatewayResult`	`updateGateway(UpdateGatewayRequest request)` Updates a gateway's name.
`UpdateGatewayCapabilityConfigurationResult`	`updateGatewayCapabilityConfiguration(UpdateGatewayCapabilityConfigurationRequest request)` Updates a gateway capability configuration or defines a new capability configuration.
`UpdatePortalResult`	`updatePortal(UpdatePortalRequest request)` Updates an IoT SiteWise Monitor portal.
`UpdateProjectResult`	`updateProject(UpdateProjectRequest request)` Updates an IoT SiteWise Monitor project.
`AWSIoTSiteWiseWaiters`	`waiters()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - associateAssets
```
public AssociateAssetsResult associateAssets(AssociateAssetsRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    associateAssets in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the AssociateAssets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - associateTimeSeriesToAssetProperty
```
public AssociateTimeSeriesToAssetPropertyResult associateTimeSeriesToAssetProperty(AssociateTimeSeriesToAssetPropertyRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Associates a time series (data stream) with an asset property.
    
    Specified by:
    
    associateTimeSeriesToAssetProperty in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the AssociateTimeSeriesToAssetProperty operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchAssociateProjectAssets
```
public BatchAssociateProjectAssetsResult batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Associates a group (batch) of assets with an IoT SiteWise Monitor project.
    
    Specified by:
    
    batchAssociateProjectAssets in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the BatchAssociateProjectAssets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchDisassociateProjectAssets
```
public BatchDisassociateProjectAssetsResult batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Disassociates a group (batch) of assets from an IoT SiteWise Monitor project.
    
    Specified by:
    
    batchDisassociateProjectAssets in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the BatchDisassociateProjectAssets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetAssetPropertyAggregates
```
public BatchGetAssetPropertyAggregatesResult batchGetAssetPropertyAggregates(BatchGetAssetPropertyAggregatesRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    batchGetAssetPropertyAggregates in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the BatchGetAssetPropertyAggregates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetAssetPropertyValue
```
public BatchGetAssetPropertyValueResult batchGetAssetPropertyValue(BatchGetAssetPropertyValueRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Gets the current value for one or more asset properties. For more information, see Querying current values in the IoT SiteWise User Guide.
    
    Specified by:
    
    batchGetAssetPropertyValue in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the BatchGetAssetPropertyValue operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchGetAssetPropertyValueHistory
```
public BatchGetAssetPropertyValueHistoryResult batchGetAssetPropertyValueHistory(BatchGetAssetPropertyValueHistoryRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Gets the historical values for one or more asset properties. For more information, see Querying historical values in the IoT SiteWise User Guide.
    
    Specified by:
    
    batchGetAssetPropertyValueHistory in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the BatchGetAssetPropertyValueHistory operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - batchPutAssetPropertyValue
```
public BatchPutAssetPropertyValueResult batchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    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.
    Specified by:
    
    batchPutAssetPropertyValue in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the BatchPutAssetPropertyValue operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAccessPolicy
```
public CreateAccessPolicyResult createAccessPolicy(CreateAccessPolicyRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    createAccessPolicy in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the CreateAccessPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAsset
```
public CreateAssetResult createAsset(CreateAssetRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Creates an asset from an existing asset model. For more information, see Creating assets in the IoT SiteWise User Guide.
    
    Specified by:
    
    createAsset in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the CreateAsset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createAssetModel
```
public CreateAssetModelResult createAssetModel(CreateAssetModelRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    createAssetModel in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the CreateAssetModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createBulkImportJob
```
public CreateBulkImportJobResult createBulkImportJob(CreateBulkImportJobRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    createBulkImportJob in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the CreateBulkImportJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createDashboard
```
public CreateDashboardResult createDashboard(CreateDashboardRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Creates a dashboard in an IoT SiteWise Monitor project.
    
    Specified by:
    
    createDashboard in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the CreateDashboard operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createGateway
```
public CreateGatewayResult createGateway(CreateGatewayRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    createGateway in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the CreateGateway operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createPortal
```
public CreatePortalResult createPortal(CreatePortalRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    createPortal in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the CreatePortal operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createProject
```
public CreateProjectResult createProject(CreateProjectRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Creates a project in the specified portal.
    
    Make sure that the project name and description don't contain confidential information.
    
    Specified by:
    
    createProject in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the CreateProject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAccessPolicy
```
public DeleteAccessPolicyResult deleteAccessPolicy(DeleteAccessPolicyRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    deleteAccessPolicy in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DeleteAccessPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAsset
```
public DeleteAssetResult deleteAsset(DeleteAssetRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    deleteAsset in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DeleteAsset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteAssetModel
```
public DeleteAssetModelResult deleteAssetModel(DeleteAssetModelRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    deleteAssetModel in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DeleteAssetModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteDashboard
```
public DeleteDashboardResult deleteDashboard(DeleteDashboardRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Deletes a dashboard from IoT SiteWise Monitor.
    
    Specified by:
    
    deleteDashboard in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DeleteDashboard operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteGateway
```
public DeleteGatewayResult deleteGateway(DeleteGatewayRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Deletes a gateway from IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system.
    
    Specified by:
    
    deleteGateway in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DeleteGateway operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deletePortal
```
public DeletePortalResult deletePortal(DeletePortalRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Deletes a portal from IoT SiteWise Monitor.
    
    Specified by:
    
    deletePortal in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DeletePortal operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteProject
```
public DeleteProjectResult deleteProject(DeleteProjectRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Deletes a project from IoT SiteWise Monitor.
    
    Specified by:
    
    deleteProject in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DeleteProject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteTimeSeries
```
public DeleteTimeSeriesResult deleteTimeSeries(DeleteTimeSeriesRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    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.
    Specified by:
    
    deleteTimeSeries in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DeleteTimeSeries operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAccessPolicy
```
public DescribeAccessPolicyResult describeAccessPolicy(DescribeAccessPolicyRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Describes an access policy, which specifies an identity's access to an IoT SiteWise Monitor portal or project.
    
    Specified by:
    
    describeAccessPolicy in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DescribeAccessPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAsset
```
public DescribeAssetResult describeAsset(DescribeAssetRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Retrieves information about an asset.
    
    Specified by:
    
    describeAsset in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DescribeAsset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAssetModel
```
public DescribeAssetModelResult describeAssetModel(DescribeAssetModelRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Retrieves information about an asset model.
    
    Specified by:
    
    describeAssetModel in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DescribeAssetModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeAssetProperty
```
public DescribeAssetPropertyResult describeAssetProperty(DescribeAssetPropertyRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    describeAssetProperty in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DescribeAssetProperty operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeBulkImportJob
```
public DescribeBulkImportJobResult describeBulkImportJob(DescribeBulkImportJobRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    describeBulkImportJob in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DescribeBulkImportJob operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDashboard
```
public DescribeDashboardResult describeDashboard(DescribeDashboardRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Retrieves information about a dashboard.
    
    Specified by:
    
    describeDashboard in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DescribeDashboard operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeDefaultEncryptionConfiguration
```
public DescribeDefaultEncryptionConfigurationResult describeDefaultEncryptionConfiguration(DescribeDefaultEncryptionConfigurationRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    describeDefaultEncryptionConfiguration in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DescribeDefaultEncryptionConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeGateway
```
public DescribeGatewayResult describeGateway(DescribeGatewayRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Retrieves information about a gateway.
    
    Specified by:
    
    describeGateway in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DescribeGateway operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeGatewayCapabilityConfiguration
```
public DescribeGatewayCapabilityConfigurationResult describeGatewayCapabilityConfiguration(DescribeGatewayCapabilityConfigurationRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    describeGatewayCapabilityConfiguration in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DescribeGatewayCapabilityConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeLoggingOptions
```
public DescribeLoggingOptionsResult describeLoggingOptions(DescribeLoggingOptionsRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Retrieves the current IoT SiteWise logging options.
    
    Specified by:
    
    describeLoggingOptions in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DescribeLoggingOptions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describePortal
```
public DescribePortalResult describePortal(DescribePortalRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Retrieves information about a portal.
    
    Specified by:
    
    describePortal in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DescribePortal operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeProject
```
public DescribeProjectResult describeProject(DescribeProjectRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Retrieves information about a project.
    
    Specified by:
    
    describeProject in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DescribeProject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeStorageConfiguration
```
public DescribeStorageConfigurationResult describeStorageConfiguration(DescribeStorageConfigurationRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Retrieves information about the storage configuration for IoT SiteWise.
    
    Specified by:
    
    describeStorageConfiguration in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DescribeStorageConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - describeTimeSeries
```
public DescribeTimeSeriesResult describeTimeSeries(DescribeTimeSeriesRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    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.
    Specified by:
    
    describeTimeSeries in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DescribeTimeSeries operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateAssets
```
public DisassociateAssetsResult disassociateAssets(DisassociateAssetsRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
    
    Specified by:
    
    disassociateAssets in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DisassociateAssets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - disassociateTimeSeriesFromAssetProperty
```
public DisassociateTimeSeriesFromAssetPropertyResult disassociateTimeSeriesFromAssetProperty(DisassociateTimeSeriesFromAssetPropertyRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Disassociates a time series (data stream) from an asset property.
    
    Specified by:
    
    disassociateTimeSeriesFromAssetProperty in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the DisassociateTimeSeriesFromAssetProperty operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAssetPropertyAggregates
```
public GetAssetPropertyAggregatesResult getAssetPropertyAggregates(GetAssetPropertyAggregatesRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    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.
    Specified by:
    
    getAssetPropertyAggregates in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the GetAssetPropertyAggregates operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAssetPropertyValue
```
public GetAssetPropertyValueResult getAssetPropertyValue(GetAssetPropertyValueRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    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.
    Specified by:
    
    getAssetPropertyValue in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the GetAssetPropertyValue operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getAssetPropertyValueHistory
```
public GetAssetPropertyValueHistoryResult getAssetPropertyValueHistory(GetAssetPropertyValueHistoryRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    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.
    Specified by:
    
    getAssetPropertyValueHistory in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the GetAssetPropertyValueHistory operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getInterpolatedAssetPropertyValues
```
public GetInterpolatedAssetPropertyValuesResult getInterpolatedAssetPropertyValues(GetInterpolatedAssetPropertyValuesRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    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.
    Specified by:
    
    getInterpolatedAssetPropertyValues in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the GetInterpolatedAssetPropertyValues operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAccessPolicies
```
public ListAccessPoliciesResult listAccessPolicies(ListAccessPoliciesRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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).
    
    Specified by:
    
    listAccessPolicies in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the ListAccessPolicies operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAssetModelProperties
```
public ListAssetModelPropertiesResult listAssetModelProperties(ListAssetModelPropertiesRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    listAssetModelProperties in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the ListAssetModelProperties operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAssetModels
```
public ListAssetModelsResult listAssetModels(ListAssetModelsRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Retrieves a paginated list of summaries of all asset models.
    
    Specified by:
    
    listAssetModels in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the ListAssetModels operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAssetProperties
```
public ListAssetPropertiesResult listAssetProperties(ListAssetPropertiesRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    listAssetProperties in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the ListAssetProperties operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAssetRelationships
```
public ListAssetRelationshipsResult listAssetRelationships(ListAssetRelationshipsRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    listAssetRelationships in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the ListAssetRelationships operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAssets
```
public ListAssetsResult listAssets(ListAssetsRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    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.
    Specified by:
    
    listAssets in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the ListAssets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listAssociatedAssets
```
public ListAssociatedAssetsResult listAssociatedAssets(ListAssociatedAssetsRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    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.
    Specified by:
    
    listAssociatedAssets in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the ListAssociatedAssets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listBulkImportJobs
```
public ListBulkImportJobsResult listBulkImportJobs(ListBulkImportJobsRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Retrieves a paginated list of bulk import job requests. For more information, see List bulk import jobs (CLI) in the IoT SiteWise User Guide.
    
    Specified by:
    
    listBulkImportJobs in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the ListBulkImportJobs operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listDashboards
```
public ListDashboardsResult listDashboards(ListDashboardsRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Retrieves a paginated list of dashboards for an IoT SiteWise Monitor project.
    
    Specified by:
    
    listDashboards in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the ListDashboards operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listGateways
```
public ListGatewaysResult listGateways(ListGatewaysRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Retrieves a paginated list of gateways.
    
    Specified by:
    
    listGateways in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the ListGateways operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listPortals
```
public ListPortalsResult listPortals(ListPortalsRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Retrieves a paginated list of IoT SiteWise Monitor portals.
    
    Specified by:
    
    listPortals in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the ListPortals operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listProjectAssets
```
public ListProjectAssetsResult listProjectAssets(ListProjectAssetsRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Retrieves a paginated list of assets associated with an IoT SiteWise Monitor project.
    
    Specified by:
    
    listProjectAssets in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the ListProjectAssets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listProjects
```
public ListProjectsResult listProjects(ListProjectsRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Retrieves a paginated list of projects for an IoT SiteWise Monitor portal.
    
    Specified by:
    
    listProjects in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the ListProjects operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Retrieves the list of tags for an IoT SiteWise resource.
    
    Specified by:
    
    listTagsForResource in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTimeSeries
```
public ListTimeSeriesResult listTimeSeries(ListTimeSeriesRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Retrieves a paginated list of time series (data streams).
    
    Specified by:
    
    listTimeSeries in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the ListTimeSeries operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putDefaultEncryptionConfiguration
```
public PutDefaultEncryptionConfigurationResult putDefaultEncryptionConfiguration(PutDefaultEncryptionConfigurationRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Sets the default encryption configuration for the Amazon Web Services account. For more information, see Key management in the IoT SiteWise User Guide.
    
    Specified by:
    
    putDefaultEncryptionConfiguration in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the PutDefaultEncryptionConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putLoggingOptions
```
public PutLoggingOptionsResult putLoggingOptions(PutLoggingOptionsRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Sets logging options for IoT SiteWise.
    
    Specified by:
    
    putLoggingOptions in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the PutLoggingOptions operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - putStorageConfiguration
```
public PutStorageConfigurationResult putStorageConfiguration(PutStorageConfigurationRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Configures storage settings for IoT SiteWise.
    
    Specified by:
    
    putStorageConfiguration in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the PutStorageConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Adds tags to an IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
    
    Specified by:
    
    tagResource in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Removes a tag from an IoT SiteWise resource.
    
    Specified by:
    
    untagResource in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAccessPolicy
```
public UpdateAccessPolicyResult updateAccessPolicy(UpdateAccessPolicyRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Updates an existing access policy that specifies an identity's access to an IoT SiteWise Monitor portal or project resource.
    
    Specified by:
    
    updateAccessPolicy in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the UpdateAccessPolicy operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAsset
```
public UpdateAssetResult updateAsset(UpdateAssetRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Updates an asset's name. For more information, see Updating assets and models in the IoT SiteWise User Guide.
    
    Specified by:
    
    updateAsset in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the UpdateAsset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAssetModel
```
public UpdateAssetModelResult updateAssetModel(UpdateAssetModelRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    updateAssetModel in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the UpdateAssetModel operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateAssetProperty
```
public UpdateAssetPropertyResult updateAssetProperty(UpdateAssetPropertyRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    updateAssetProperty in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the UpdateAssetProperty operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateDashboard
```
public UpdateDashboardResult updateDashboard(UpdateDashboardRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Updates an IoT SiteWise Monitor dashboard.
    
    Specified by:
    
    updateDashboard in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the UpdateDashboard operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateGateway
```
public UpdateGatewayResult updateGateway(UpdateGatewayRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Updates a gateway's name.
    
    Specified by:
    
    updateGateway in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the UpdateGateway operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateGatewayCapabilityConfiguration
```
public UpdateGatewayCapabilityConfigurationResult updateGatewayCapabilityConfiguration(UpdateGatewayCapabilityConfigurationRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    updateGatewayCapabilityConfiguration in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the UpdateGatewayCapabilityConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updatePortal
```
public UpdatePortalResult updatePortal(UpdatePortalRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Updates an IoT SiteWise Monitor portal.
    
    Specified by:
    
    updatePortal in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the UpdatePortal operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateProject
```
public UpdateProjectResult updateProject(UpdateProjectRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    Updates an IoT SiteWise Monitor project.
    
    Specified by:
    
    updateProject in interface AWSIoTSiteWise
    
    Returns:
    
    Result of the UpdateProject operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    shutdown in interface AWSIoTSiteWise
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSIoTSiteWise
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSIoTSiteWise
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
public AWSIoTSiteWiseWaiters waiters()
```
    Specified by:
    
    waiters in interface AWSIoTSiteWise

Did this page help you?

Class AbstractAWSIoTSiteWise

Field Summary

Fields inherited from interface com.amazonaws.services.iotsitewise.AWSIoTSiteWise

Method Summary

Methods inherited from class java.lang.Object

Method Detail

associateAssets

associateTimeSeriesToAssetProperty

batchAssociateProjectAssets

batchDisassociateProjectAssets

batchGetAssetPropertyAggregates

batchGetAssetPropertyValue

batchGetAssetPropertyValueHistory

batchPutAssetPropertyValue

createAccessPolicy

createAsset

createAssetModel

createBulkImportJob

createDashboard

createGateway

createPortal

createProject

deleteAccessPolicy

deleteAsset

deleteAssetModel

deleteDashboard

deleteGateway

deletePortal

deleteProject

deleteTimeSeries

describeAccessPolicy

describeAsset

describeAssetModel

describeAssetProperty

describeBulkImportJob

describeDashboard

describeDefaultEncryptionConfiguration

describeGateway

describeGatewayCapabilityConfiguration

describeLoggingOptions

describePortal

describeProject

describeStorageConfiguration

describeTimeSeries

disassociateAssets

disassociateTimeSeriesFromAssetProperty

getAssetPropertyAggregates

getAssetPropertyValue

getAssetPropertyValueHistory

getInterpolatedAssetPropertyValues

listAccessPolicies

listAssetModelProperties

listAssetModels

listAssetProperties

listAssetRelationships

listAssets

listAssociatedAssets

listBulkImportJobs

listDashboards

listGateways

listPortals

listProjectAssets

listProjects

listTagsForResource

listTimeSeries

putDefaultEncryptionConfiguration

putLoggingOptions

putStorageConfiguration

tagResource

untagResource

updateAccessPolicy

updateAsset

updateAssetModel

updateAssetProperty

updateDashboard

updateGateway

updateGatewayCapabilityConfiguration

updatePortal

updateProject