AWSIoTSiteWise (AWS SDK for Java

All Known Subinterfaces:

AWSIoTSiteWiseAsync

All Known Implementing Classes:

AbstractAWSIoTSiteWise, AbstractAWSIoTSiteWiseAsync, AWSIoTSiteWiseAsyncClient, AWSIoTSiteWiseClient
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSIoTSiteWise
```
Interface for accessing AWS IoT SiteWise.
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSIoTSiteWise instead.

Welcome to the AWS IoT SiteWise API Reference. AWS IoT SiteWise is an AWS service that connects Industrial Internet of Things (IIoT) devices to the power of the AWS Cloud. For more information, see the AWS IoT SiteWise User Guide. For information about AWS IoT SiteWise quotas, see Quotas in the AWS IoT SiteWise User Guide.

Field Summary

Fields
Modifier and Type Field and Description

static String ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.

Fields
Modifier and Type	Field and Description
`static String`	`ENDPOINT_PREFIX` The region metadata service name for computing region endpoints.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`AssociateAssetsResult`	`associateAssets(AssociateAssetsRequest associateAssetsRequest)` Associates a child asset with the given parent asset through a hierarchy defined in the parent asset's model.
`BatchAssociateProjectAssetsResult`	`batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest batchAssociateProjectAssetsRequest)` Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.
`BatchDisassociateProjectAssetsResult`	`batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest batchDisassociateProjectAssetsRequest)` Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.
`BatchPutAssetPropertyValueResult`	`batchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest batchPutAssetPropertyValueRequest)` Sends a list of asset property values to AWS IoT SiteWise.
`CreateAccessPolicyResult`	`createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest)` Creates an access policy that grants the specified AWS Single Sign-On user or group access to the specified AWS IoT SiteWise Monitor portal or project resource.
`CreateAssetResult`	`createAsset(CreateAssetRequest createAssetRequest)` Creates an asset from an existing asset model.
`CreateAssetModelResult`	`createAssetModel(CreateAssetModelRequest createAssetModelRequest)` Creates an asset model from specified property and hierarchy definitions.
`CreateDashboardResult`	`createDashboard(CreateDashboardRequest createDashboardRequest)` Creates a dashboard in an AWS IoT SiteWise Monitor project.
`CreateGatewayResult`	`createGateway(CreateGatewayRequest createGatewayRequest)` Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise.
`CreatePortalResult`	`createPortal(CreatePortalRequest createPortalRequest)` Creates a portal, which can contain projects and dashboards.
`CreateProjectResult`	`createProject(CreateProjectRequest createProjectRequest)` Creates a project in the specified portal.
`DeleteAccessPolicyResult`	`deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest)` Deletes an access policy that grants the specified AWS Single Sign-On identity access to the specified AWS IoT SiteWise Monitor resource.
`DeleteAssetResult`	`deleteAsset(DeleteAssetRequest deleteAssetRequest)` Deletes an asset.
`DeleteAssetModelResult`	`deleteAssetModel(DeleteAssetModelRequest deleteAssetModelRequest)` Deletes an asset model.
`DeleteDashboardResult`	`deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)` Deletes a dashboard from AWS IoT SiteWise Monitor.
`DeleteGatewayResult`	`deleteGateway(DeleteGatewayRequest deleteGatewayRequest)` Deletes a gateway from AWS IoT SiteWise.
`DeletePortalResult`	`deletePortal(DeletePortalRequest deletePortalRequest)` Deletes a portal from AWS IoT SiteWise Monitor.
`DeleteProjectResult`	`deleteProject(DeleteProjectRequest deleteProjectRequest)` Deletes a project from AWS IoT SiteWise Monitor.
`DescribeAccessPolicyResult`	`describeAccessPolicy(DescribeAccessPolicyRequest describeAccessPolicyRequest)` Describes an access policy, which specifies an AWS SSO user or group's access to an AWS IoT SiteWise Monitor portal or project.
`DescribeAssetResult`	`describeAsset(DescribeAssetRequest describeAssetRequest)` Retrieves information about an asset.
`DescribeAssetModelResult`	`describeAssetModel(DescribeAssetModelRequest describeAssetModelRequest)` Retrieves information about an asset model.
`DescribeAssetPropertyResult`	`describeAssetProperty(DescribeAssetPropertyRequest describeAssetPropertyRequest)` Retrieves information about an asset's property.
`DescribeDashboardResult`	`describeDashboard(DescribeDashboardRequest describeDashboardRequest)` Retrieves information about a dashboard.
`DescribeGatewayResult`	`describeGateway(DescribeGatewayRequest describeGatewayRequest)` Retrieves information about a gateway.
`DescribeGatewayCapabilityConfigurationResult`	`describeGatewayCapabilityConfiguration(DescribeGatewayCapabilityConfigurationRequest describeGatewayCapabilityConfigurationRequest)` Retrieves information about a gateway capability configuration.
`DescribeLoggingOptionsResult`	`describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest)` Retrieves the current AWS IoT SiteWise logging options.
`DescribePortalResult`	`describePortal(DescribePortalRequest describePortalRequest)` Retrieves information about a portal.
`DescribeProjectResult`	`describeProject(DescribeProjectRequest describeProjectRequest)` Retrieves information about a project.
`DisassociateAssetsResult`	`disassociateAssets(DisassociateAssetsRequest disassociateAssetsRequest)` Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
`GetAssetPropertyAggregatesResult`	`getAssetPropertyAggregates(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest)` Gets aggregated values for an asset property.
`GetAssetPropertyValueResult`	`getAssetPropertyValue(GetAssetPropertyValueRequest getAssetPropertyValueRequest)` Gets an asset property's current value.
`GetAssetPropertyValueHistoryResult`	`getAssetPropertyValueHistory(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest)` 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.
`ListAccessPoliciesResult`	`listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest)` Retrieves a paginated list of access policies for an AWS SSO identity (a user or group) or an AWS IoT SiteWise Monitor resource (a portal or project).
`ListAssetModelsResult`	`listAssetModels(ListAssetModelsRequest listAssetModelsRequest)` Retrieves a paginated list of summaries of all asset models.
`ListAssetsResult`	`listAssets(ListAssetsRequest listAssetsRequest)` Retrieves a paginated list of asset summaries.
`ListAssociatedAssetsResult`	`listAssociatedAssets(ListAssociatedAssetsRequest listAssociatedAssetsRequest)` Retrieves a paginated list of the assets associated to a parent asset (`assetId`) by a given hierarchy (`hierarchyId`).
`ListDashboardsResult`	`listDashboards(ListDashboardsRequest listDashboardsRequest)` Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
`ListGatewaysResult`	`listGateways(ListGatewaysRequest listGatewaysRequest)` Retrieves a paginated list of gateways.
`ListPortalsResult`	`listPortals(ListPortalsRequest listPortalsRequest)` Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
`ListProjectAssetsResult`	`listProjectAssets(ListProjectAssetsRequest listProjectAssetsRequest)` Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
`ListProjectsResult`	`listProjects(ListProjectsRequest listProjectsRequest)` Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
`ListTagsForResourceResult`	`listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)` Retrieves the list of tags for an AWS IoT SiteWise resource.
`PutLoggingOptionsResult`	`putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest)` Sets logging options for AWS IoT SiteWise.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`TagResourceResult`	`tagResource(TagResourceRequest tagResourceRequest)` Adds tags to an AWS IoT SiteWise resource.
`UntagResourceResult`	`untagResource(UntagResourceRequest untagResourceRequest)` Removes a tag from an AWS IoT SiteWise resource.
`UpdateAccessPolicyResult`	`updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest)` Updates an existing access policy that specifies an AWS SSO user or group's access to an AWS IoT SiteWise Monitor portal or project resource.
`UpdateAssetResult`	`updateAsset(UpdateAssetRequest updateAssetRequest)` Updates an asset's name.
`UpdateAssetModelResult`	`updateAssetModel(UpdateAssetModelRequest updateAssetModelRequest)` Updates an asset model and all of the assets that were created from the model.
`UpdateAssetPropertyResult`	`updateAssetProperty(UpdateAssetPropertyRequest updateAssetPropertyRequest)` Updates an asset property's alias and notification state.
`UpdateDashboardResult`	`updateDashboard(UpdateDashboardRequest updateDashboardRequest)` Updates an AWS IoT SiteWise Monitor dashboard.
`UpdateGatewayResult`	`updateGateway(UpdateGatewayRequest updateGatewayRequest)` Updates a gateway's name.
`UpdateGatewayCapabilityConfigurationResult`	`updateGatewayCapabilityConfiguration(UpdateGatewayCapabilityConfigurationRequest updateGatewayCapabilityConfigurationRequest)` Updates a gateway capability configuration or defines a new capability configuration.
`UpdatePortalResult`	`updatePortal(UpdatePortalRequest updatePortalRequest)` Updates an AWS IoT SiteWise Monitor portal.
`UpdateProjectResult`	`updateProject(UpdateProjectRequest updateProjectRequest)` Updates an AWS IoT SiteWise Monitor project.
`AWSIoTSiteWiseWaiters`	`waiters()`

- Field Detail
  - ENDPOINT_PREFIX
```
static final String ENDPOINT_PREFIX
```
    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 Also:
    
    RegionUtils.getRegionsForService(String), Constant Field Values
- Method Detail
  - associateAssets
```
AssociateAssetsResult associateAssets(AssociateAssetsRequest associateAssetsRequest)
```
    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 AWS IoT SiteWise User Guide.
    
    Parameters:
    
    associateAssetsRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    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 AWS IoT SiteWise User Guide.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - batchAssociateProjectAssets
```
BatchAssociateProjectAssetsResult batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest batchAssociateProjectAssetsRequest)
```
    Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.
    
    Parameters:
    
    batchAssociateProjectAssetsRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - batchDisassociateProjectAssets
```
BatchDisassociateProjectAssetsResult batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest batchDisassociateProjectAssetsRequest)
```
    Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.
    
    Parameters:
    
    batchDisassociateProjectAssetsRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - batchPutAssetPropertyValue
```
BatchPutAssetPropertyValueResult batchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest batchPutAssetPropertyValueRequest)
```
    Sends a list of asset property values to AWS IoT SiteWise. Each value is a timestamp-quality-value (TQV) data point. For more information, see Ingesting Data Using the API in the AWS 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, AWS IoT SiteWise accepts only TQVs that have a timestamp of no more than 15 minutes in the past and no more than 5 minutes in the future. AWS IoT SiteWise rejects timestamps outside of the inclusive range of [-15, +5] minutes and returns a TimestampOutOfRangeException error.
    
    For each asset property, AWS 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.
    Parameters:
    
    batchPutAssetPropertyValueRequest -
    
    Returns:
    
    Result of the BatchPutAssetPropertyValue 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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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 AWS IoT SiteWise User Guide.
    
    ServiceUnavailableException - The requested service is unavailable.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createAccessPolicy
```
CreateAccessPolicyResult createAccessPolicy(CreateAccessPolicyRequest createAccessPolicyRequest)
```
    Creates an access policy that grants the specified AWS Single Sign-On user or group access to the specified AWS IoT SiteWise Monitor portal or project resource.
    
    Parameters:
    
    createAccessPolicyRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - createAsset
```
CreateAssetResult createAsset(CreateAssetRequest createAssetRequest)
```
    Creates an asset from an existing asset model. For more information, see Creating Assets in the AWS IoT SiteWise User Guide.
    
    Parameters:
    
    createAssetRequest -
    
    Returns:
    
    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.
    
    ResourceAlreadyExistsException - The resource already exists.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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 AWS IoT SiteWise User Guide.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createAssetModel
```
CreateAssetModelResult createAssetModel(CreateAssetModelRequest createAssetModelRequest)
```
    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 AWS IoT SiteWise User Guide.
    
    Parameters:
    
    createAssetModelRequest -
    
    Returns:
    
    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.
    
    ResourceAlreadyExistsException - The resource already exists.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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 AWS IoT SiteWise User Guide.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - createDashboard
```
CreateDashboardResult createDashboard(CreateDashboardRequest createDashboardRequest)
```
    Creates a dashboard in an AWS IoT SiteWise Monitor project.
    
    Parameters:
    
    createDashboardRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - createGateway
```
CreateGatewayResult createGateway(CreateGatewayRequest createGatewayRequest)
```
    Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to AWS IoT SiteWise. For more information, see Ingesting data using a gateway in the AWS IoT SiteWise User Guide.
    
    Parameters:
    
    createGatewayRequest -
    
    Returns:
    
    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.
    
    ResourceAlreadyExistsException - The resource already exists.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - createPortal
```
CreatePortalResult createPortal(CreatePortalRequest createPortalRequest)
```
    Creates a portal, which can contain projects and dashboards. Before you can create a portal, you must configure AWS Single Sign-On in the current Region. AWS IoT SiteWise Monitor uses AWS SSO to manage user permissions. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide.
    
    Before you can sign in to a new portal, you must add at least one AWS SSO user or group to that portal. For more information, see Adding or Removing Portal Administrators in the AWS IoT SiteWise User Guide.
    
    Parameters:
    
    createPortalRequest -
    
    Returns:
    
    Result of the CreatePortal 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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - createProject
```
CreateProjectResult createProject(CreateProjectRequest createProjectRequest)
```
    Creates a project in the specified portal.
    
    Parameters:
    
    createProjectRequest -
    
    Returns:
    
    Result of the CreateProject 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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - deleteAccessPolicy
```
DeleteAccessPolicyResult deleteAccessPolicy(DeleteAccessPolicyRequest deleteAccessPolicyRequest)
```
    Deletes an access policy that grants the specified AWS Single Sign-On identity access to the specified AWS IoT SiteWise Monitor resource. You can use this operation to revoke access to an AWS IoT SiteWise Monitor resource.
    
    Parameters:
    
    deleteAccessPolicyRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - deleteAsset
```
DeleteAssetResult deleteAsset(DeleteAssetRequest deleteAssetRequest)
```
    Deletes an asset. This action can't be undone. For more information, see Deleting Assets and Models in the AWS IoT SiteWise User Guide.
    
    You can't delete an asset that's associated to another asset. For more information, see DisassociateAssets.
    
    Parameters:
    
    deleteAssetRequest -
    
    Returns:
    
    Result of the DeleteAsset 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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteAssetModel
```
DeleteAssetModelResult deleteAssetModel(DeleteAssetModelRequest deleteAssetModelRequest)
```
    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 AWS IoT SiteWise User Guide.
    
    Parameters:
    
    deleteAssetModelRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteDashboard
```
DeleteDashboardResult deleteDashboard(DeleteDashboardRequest deleteDashboardRequest)
```
    Deletes a dashboard from AWS IoT SiteWise Monitor.
    
    Parameters:
    
    deleteDashboardRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - deleteGateway
```
DeleteGatewayResult deleteGateway(DeleteGatewayRequest deleteGatewayRequest)
```
    Deletes a gateway from AWS IoT SiteWise. When you delete a gateway, some of the gateway's files remain in your gateway's file system. For more information, see Data retention in the AWS IoT SiteWise User Guide.
    
    Parameters:
    
    deleteGatewayRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - deletePortal
```
DeletePortalResult deletePortal(DeletePortalRequest deletePortalRequest)
```
    Deletes a portal from AWS IoT SiteWise Monitor.
    
    Parameters:
    
    deletePortalRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - deleteProject
```
DeleteProjectResult deleteProject(DeleteProjectRequest deleteProjectRequest)
```
    Deletes a project from AWS IoT SiteWise Monitor.
    
    Parameters:
    
    deleteProjectRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - describeAccessPolicy
```
DescribeAccessPolicyResult describeAccessPolicy(DescribeAccessPolicyRequest describeAccessPolicyRequest)
```
    Describes an access policy, which specifies an AWS SSO user or group's access to an AWS IoT SiteWise Monitor portal or project.
    
    Parameters:
    
    describeAccessPolicyRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - describeAsset
```
DescribeAssetResult describeAsset(DescribeAssetRequest describeAssetRequest)
```
    Retrieves information about an asset.
    
    Parameters:
    
    describeAssetRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - describeAssetModel
```
DescribeAssetModelResult describeAssetModel(DescribeAssetModelRequest describeAssetModelRequest)
```
    Retrieves information about an asset model.
    
    Parameters:
    
    describeAssetModelRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - describeAssetProperty
```
DescribeAssetPropertyResult describeAssetProperty(DescribeAssetPropertyRequest describeAssetPropertyRequest)
```
    Retrieves information about an asset's property.
    
    Parameters:
    
    describeAssetPropertyRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - describeDashboard
```
DescribeDashboardResult describeDashboard(DescribeDashboardRequest describeDashboardRequest)
```
    Retrieves information about a dashboard.
    
    Parameters:
    
    describeDashboardRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - describeGateway
```
DescribeGatewayResult describeGateway(DescribeGatewayRequest describeGatewayRequest)
```
    Retrieves information about a gateway.
    
    Parameters:
    
    describeGatewayRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - describeGatewayCapabilityConfiguration
```
DescribeGatewayCapabilityConfigurationResult describeGatewayCapabilityConfiguration(DescribeGatewayCapabilityConfigurationRequest describeGatewayCapabilityConfigurationRequest)
```
    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 AWS 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.
    
    Parameters:
    
    describeGatewayCapabilityConfigurationRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - describeLoggingOptions
```
DescribeLoggingOptionsResult describeLoggingOptions(DescribeLoggingOptionsRequest describeLoggingOptionsRequest)
```
    Retrieves the current AWS IoT SiteWise logging options.
    
    Parameters:
    
    describeLoggingOptionsRequest -
    
    Returns:
    
    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.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    See Also:
    
    AWS API Documentation
  - describePortal
```
DescribePortalResult describePortal(DescribePortalRequest describePortalRequest)
```
    Retrieves information about a portal.
    
    Parameters:
    
    describePortalRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - describeProject
```
DescribeProjectResult describeProject(DescribeProjectRequest describeProjectRequest)
```
    Retrieves information about a project.
    
    Parameters:
    
    describeProjectRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - disassociateAssets
```
DisassociateAssetsResult disassociateAssets(DisassociateAssetsRequest disassociateAssetsRequest)
```
    Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
    
    Parameters:
    
    disassociateAssetsRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - getAssetPropertyAggregates
```
GetAssetPropertyAggregatesResult getAssetPropertyAggregates(GetAssetPropertyAggregatesRequest getAssetPropertyAggregatesRequest)
```
    Gets aggregated values for an asset property. For more information, see Querying Aggregated Property Values in the AWS 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.
    Parameters:
    
    getAssetPropertyAggregatesRequest -
    
    Returns:
    
    Result of the GetAssetPropertyAggregates 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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    ServiceUnavailableException - The requested service is unavailable.
    
    See Also:
    
    AWS API Documentation
  - getAssetPropertyValue
```
GetAssetPropertyValueResult getAssetPropertyValue(GetAssetPropertyValueRequest getAssetPropertyValueRequest)
```
    Gets an asset property's current value. For more information, see Querying Current Property Values in the AWS 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.
    Parameters:
    
    getAssetPropertyValueRequest -
    
    Returns:
    
    Result of the GetAssetPropertyValue 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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    ServiceUnavailableException - The requested service is unavailable.
    
    See Also:
    
    AWS API Documentation
  - getAssetPropertyValueHistory
```
GetAssetPropertyValueHistoryResult getAssetPropertyValueHistory(GetAssetPropertyValueHistoryRequest getAssetPropertyValueHistoryRequest)
```
    Gets the history of an asset property's values. For more information, see Querying Historical Property Values in the AWS 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.
    Parameters:
    
    getAssetPropertyValueHistoryRequest -
    
    Returns:
    
    Result of the GetAssetPropertyValueHistory 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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    ServiceUnavailableException - The requested service is unavailable.
    
    See Also:
    
    AWS API Documentation
  - listAccessPolicies
```
ListAccessPoliciesResult listAccessPolicies(ListAccessPoliciesRequest listAccessPoliciesRequest)
```
    Retrieves a paginated list of access policies for an AWS SSO identity (a user or group) or an AWS IoT SiteWise Monitor resource (a portal or project).
    
    Parameters:
    
    listAccessPoliciesRequest -
    
    Returns:
    
    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.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - listAssetModels
```
ListAssetModelsResult listAssetModels(ListAssetModelsRequest listAssetModelsRequest)
```
    Retrieves a paginated list of summaries of all asset models.
    
    Parameters:
    
    listAssetModelsRequest -
    
    Returns:
    
    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.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - listAssets
```
ListAssetsResult listAssets(ListAssetsRequest listAssetsRequest)
```
    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.
    Parameters:
    
    listAssetsRequest -
    
    Returns:
    
    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.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - listAssociatedAssets
```
ListAssociatedAssetsResult listAssociatedAssets(ListAssociatedAssetsRequest listAssociatedAssetsRequest)
```
    Retrieves a paginated list of the assets associated to a parent asset (assetId) by a given hierarchy (hierarchyId).
    
    Parameters:
    
    listAssociatedAssetsRequest -
    
    Returns:
    
    Result of the ListAssociatedAssets 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.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - listDashboards
```
ListDashboardsResult listDashboards(ListDashboardsRequest listDashboardsRequest)
```
    Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
    
    Parameters:
    
    listDashboardsRequest -
    
    Returns:
    
    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.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - listGateways
```
ListGatewaysResult listGateways(ListGatewaysRequest listGatewaysRequest)
```
    Retrieves a paginated list of gateways.
    
    Parameters:
    
    listGatewaysRequest -
    
    Returns:
    
    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.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - listPortals
```
ListPortalsResult listPortals(ListPortalsRequest listPortalsRequest)
```
    Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
    
    Parameters:
    
    listPortalsRequest -
    
    Returns:
    
    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.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - listProjectAssets
```
ListProjectAssetsResult listProjectAssets(ListProjectAssetsRequest listProjectAssetsRequest)
```
    Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
    
    Parameters:
    
    listProjectAssetsRequest -
    
    Returns:
    
    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.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - listProjects
```
ListProjectsResult listProjects(ListProjectsRequest listProjectsRequest)
```
    Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
    
    Parameters:
    
    listProjectsRequest -
    
    Returns:
    
    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.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
```
    Retrieves the list of tags for an AWS IoT SiteWise resource.
    
    Parameters:
    
    listTagsForResourceRequest -
    
    Returns:
    
    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.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    See Also:
    
    AWS API Documentation
  - putLoggingOptions
```
PutLoggingOptionsResult putLoggingOptions(PutLoggingOptionsRequest putLoggingOptionsRequest)
```
    Sets logging options for AWS IoT SiteWise.
    
    Parameters:
    
    putLoggingOptionsRequest -
    
    Returns:
    
    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.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
TagResourceResult tagResource(TagResourceRequest tagResourceRequest)
```
    Adds tags to an AWS IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
    
    Parameters:
    
    tagResourceRequest -
    
    Returns:
    
    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.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    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 AWS General Reference.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)
```
    Removes a tag from an AWS IoT SiteWise resource.
    
    Parameters:
    
    untagResourceRequest -
    
    Returns:
    
    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.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    See Also:
    
    AWS API Documentation
  - updateAccessPolicy
```
UpdateAccessPolicyResult updateAccessPolicy(UpdateAccessPolicyRequest updateAccessPolicyRequest)
```
    Updates an existing access policy that specifies an AWS SSO user or group's access to an AWS IoT SiteWise Monitor portal or project resource.
    
    Parameters:
    
    updateAccessPolicyRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - updateAsset
```
UpdateAssetResult updateAsset(UpdateAssetRequest updateAssetRequest)
```
    Updates an asset's name. For more information, see Updating Assets and Models in the AWS IoT SiteWise User Guide.
    
    Parameters:
    
    updateAssetRequest -
    
    Returns:
    
    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.
    
    ResourceAlreadyExistsException - The resource already exists.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateAssetModel
```
UpdateAssetModelResult updateAssetModel(UpdateAssetModelRequest updateAssetModelRequest)
```
    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 AWS 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 or update a property's formula expression, AWS IoT SiteWise deletes all previous data for that property. If you remove a hierarchy definition from an asset model, AWS IoT SiteWise disassociates every asset associated with that hierarchy. You can't change the type or data type of an existing property.
    
    Parameters:
    
    updateAssetModelRequest -
    
    Returns:
    
    Result of the UpdateAssetModel 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.
    
    ResourceAlreadyExistsException - The resource already exists.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    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 AWS IoT SiteWise User Guide.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateAssetProperty
```
UpdateAssetPropertyResult updateAssetProperty(UpdateAssetPropertyRequest updateAssetPropertyRequest)
```
    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.
    
    Parameters:
    
    updateAssetPropertyRequest -
    
    Returns:
    
    Result of the UpdateAssetProperty 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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateDashboard
```
UpdateDashboardResult updateDashboard(UpdateDashboardRequest updateDashboardRequest)
```
    Updates an AWS IoT SiteWise Monitor dashboard.
    
    Parameters:
    
    updateDashboardRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - updateGateway
```
UpdateGatewayResult updateGateway(UpdateGatewayRequest updateGatewayRequest)
```
    Updates a gateway's name.
    
    Parameters:
    
    updateGatewayRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    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.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - updateGatewayCapabilityConfiguration
```
UpdateGatewayCapabilityConfigurationResult updateGatewayCapabilityConfiguration(UpdateGatewayCapabilityConfigurationRequest updateGatewayCapabilityConfigurationRequest)
```
    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 AWS 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.
    
    Parameters:
    
    updateGatewayCapabilityConfigurationRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    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.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - updatePortal
```
UpdatePortalResult updatePortal(UpdatePortalRequest updatePortalRequest)
```
    Updates an AWS IoT SiteWise Monitor portal.
    
    Parameters:
    
    updatePortalRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    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.
    
    See Also:
    
    AWS API Documentation
  - updateProject
```
UpdateProjectResult updateProject(UpdateProjectRequest updateProjectRequest)
```
    Updates an AWS IoT SiteWise Monitor project.
    
    Parameters:
    
    updateProjectRequest -
    
    Returns:
    
    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.
    
    ResourceNotFoundException - The requested resource can't be found.
    
    InternalFailureException - AWS IoT SiteWise can't process your request right now. Try again later.
    
    ThrottlingException - Your request exceeded a rate limit. For example, you might have exceeded the number of AWS 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 AWS IoT SiteWise User Guide.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
void shutdown()
```
    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.
  - getCachedResponseMetadata
```
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. 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.
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.
  - waiters
```
AWSIoTSiteWiseWaiters waiters()
```

Did this page help you?

Interface AWSIoTSiteWise

Field Summary

Method Summary

Field Detail

ENDPOINT_PREFIX

Method Detail

associateAssets

batchAssociateProjectAssets

batchDisassociateProjectAssets

batchPutAssetPropertyValue

createAccessPolicy

createAsset

createAssetModel

createDashboard

createGateway

createPortal

createProject

deleteAccessPolicy

deleteAsset

deleteAssetModel

deleteDashboard

deleteGateway

deletePortal

deleteProject

describeAccessPolicy

describeAsset

describeAssetModel

describeAssetProperty

describeDashboard

describeGateway

describeGatewayCapabilityConfiguration

describeLoggingOptions

describePortal

describeProject

disassociateAssets

getAssetPropertyAggregates

getAssetPropertyValue

getAssetPropertyValueHistory

listAccessPolicies

listAssetModels

listAssets

listAssociatedAssets

listDashboards

listGateways

listPortals

listProjectAssets

listProjects

listTagsForResource

putLoggingOptions

tagResource

untagResource

updateAccessPolicy

updateAsset

updateAssetModel

updateAssetProperty

updateDashboard

updateGateway

updateGatewayCapabilityConfiguration

updatePortal

updateProject

shutdown

getCachedResponseMetadata

waiters