@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSIoTSiteWiseClient extends AmazonWebServiceClient implements AWSIoTSiteWise
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.
LOGGING_AWS_REQUEST_METRIC
ENDPOINT_PREFIX
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.
|
BatchAssociateProjectAssetsResult |
batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest request)
Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.
|
BatchDisassociateProjectAssetsResult |
batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest request)
Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.
|
BatchPutAssetPropertyValueResult |
batchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest request)
Sends a list of asset property values to AWS IoT SiteWise.
|
static AWSIoTSiteWiseClientBuilder |
builder() |
CreateAccessPolicyResult |
createAccessPolicy(CreateAccessPolicyRequest request)
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 request)
Creates an asset from an existing asset model.
|
CreateAssetModelResult |
createAssetModel(CreateAssetModelRequest request)
Creates an asset model from specified property and hierarchy definitions.
|
CreateDashboardResult |
createDashboard(CreateDashboardRequest request)
Creates a dashboard in an AWS 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
AWS 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 AWS Single Sign-On identity access to the specified AWS 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 AWS IoT SiteWise Monitor.
|
DeleteGatewayResult |
deleteGateway(DeleteGatewayRequest request)
Deletes a gateway from AWS IoT SiteWise.
|
DeletePortalResult |
deletePortal(DeletePortalRequest request)
Deletes a portal from AWS IoT SiteWise Monitor.
|
DeleteProjectResult |
deleteProject(DeleteProjectRequest request)
Deletes a project from AWS IoT SiteWise Monitor.
|
DescribeAccessPolicyResult |
describeAccessPolicy(DescribeAccessPolicyRequest request)
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 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's property.
|
DescribeDashboardResult |
describeDashboard(DescribeDashboardRequest request)
Retrieves information about a dashboard.
|
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 AWS IoT SiteWise logging options.
|
DescribePortalResult |
describePortal(DescribePortalRequest request)
Retrieves information about a portal.
|
DescribeProjectResult |
describeProject(DescribeProjectRequest request)
Retrieves information about a project.
|
DisassociateAssetsResult |
disassociateAssets(DisassociateAssetsRequest request)
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
|
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.
|
ListAccessPoliciesResult |
listAccessPolicies(ListAccessPoliciesRequest request)
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 request)
Retrieves a paginated list of summaries of all asset models.
|
ListAssetsResult |
listAssets(ListAssetsRequest request)
Retrieves a paginated list of asset summaries.
|
ListAssociatedAssetsResult |
listAssociatedAssets(ListAssociatedAssetsRequest request)
Retrieves a paginated list of the assets associated to a parent asset (
assetId ) by a given hierarchy
(hierarchyId ). |
ListDashboardsResult |
listDashboards(ListDashboardsRequest request)
Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
|
ListGatewaysResult |
listGateways(ListGatewaysRequest request)
Retrieves a paginated list of gateways.
|
ListPortalsResult |
listPortals(ListPortalsRequest request)
Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
|
ListProjectAssetsResult |
listProjectAssets(ListProjectAssetsRequest request)
Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
|
ListProjectsResult |
listProjects(ListProjectsRequest request)
Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
Retrieves the list of tags for an AWS IoT SiteWise resource.
|
PutLoggingOptionsResult |
putLoggingOptions(PutLoggingOptionsRequest request)
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 request)
Adds tags to an AWS IoT SiteWise resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes a tag from an AWS IoT SiteWise resource.
|
UpdateAccessPolicyResult |
updateAccessPolicy(UpdateAccessPolicyRequest request)
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 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 AWS 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 AWS IoT SiteWise Monitor portal.
|
UpdateProjectResult |
updateProject(UpdateProjectRequest request)
Updates an AWS IoT SiteWise Monitor project.
|
AWSIoTSiteWiseWaiters |
waiters() |
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset
public static AWSIoTSiteWiseClientBuilder builder()
public AssociateAssetsResult associateAssets(AssociateAssetsRequest request)
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.
associateAssets
in interface AWSIoTSiteWise
associateAssetsRequest
- 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.public BatchAssociateProjectAssetsResult batchAssociateProjectAssets(BatchAssociateProjectAssetsRequest request)
Associates a group (batch) of assets with an AWS IoT SiteWise Monitor project.
batchAssociateProjectAssets
in interface AWSIoTSiteWise
batchAssociateProjectAssetsRequest
- 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.
public BatchDisassociateProjectAssetsResult batchDisassociateProjectAssets(BatchDisassociateProjectAssetsRequest request)
Disassociates a group (batch) of assets from an AWS IoT SiteWise Monitor project.
batchDisassociateProjectAssets
in interface AWSIoTSiteWise
batchDisassociateProjectAssetsRequest
- 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.
public BatchPutAssetPropertyValueResult batchPutAssetPropertyValue(BatchPutAssetPropertyValueRequest request)
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.
batchPutAssetPropertyValue
in interface AWSIoTSiteWise
batchPutAssetPropertyValueRequest
- 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.public CreateAccessPolicyResult createAccessPolicy(CreateAccessPolicyRequest request)
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.
createAccessPolicy
in interface AWSIoTSiteWise
createAccessPolicyRequest
- 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.
public CreateAssetResult createAsset(CreateAssetRequest request)
Creates an asset from an existing asset model. For more information, see Creating Assets in the AWS IoT SiteWise User Guide.
createAsset
in interface AWSIoTSiteWise
createAssetRequest
- 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.public CreateAssetModelResult createAssetModel(CreateAssetModelRequest request)
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.
createAssetModel
in interface AWSIoTSiteWise
createAssetModelRequest
- 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.public CreateDashboardResult createDashboard(CreateDashboardRequest request)
Creates a dashboard in an AWS IoT SiteWise Monitor project.
createDashboard
in interface AWSIoTSiteWise
createDashboardRequest
- 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.
public CreateGatewayResult createGateway(CreateGatewayRequest request)
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.
createGateway
in interface AWSIoTSiteWise
createGatewayRequest
- 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.
public CreatePortalResult createPortal(CreatePortalRequest request)
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.
createPortal
in interface AWSIoTSiteWise
createPortalRequest
- 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.
public CreateProjectResult createProject(CreateProjectRequest request)
Creates a project in the specified portal.
createProject
in interface AWSIoTSiteWise
createProjectRequest
- 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.
public DeleteAccessPolicyResult deleteAccessPolicy(DeleteAccessPolicyRequest request)
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 action to revoke access to an AWS IoT SiteWise Monitor resource.
deleteAccessPolicy
in interface AWSIoTSiteWise
deleteAccessPolicyRequest
- 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.
public DeleteAssetResult deleteAsset(DeleteAssetRequest request)
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.
deleteAsset
in interface AWSIoTSiteWise
deleteAssetRequest
- 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.public DeleteAssetModelResult deleteAssetModel(DeleteAssetModelRequest request)
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.
deleteAssetModel
in interface AWSIoTSiteWise
deleteAssetModelRequest
- 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.public DeleteDashboardResult deleteDashboard(DeleteDashboardRequest request)
Deletes a dashboard from AWS IoT SiteWise Monitor.
deleteDashboard
in interface AWSIoTSiteWise
deleteDashboardRequest
- 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.
public DeleteGatewayResult deleteGateway(DeleteGatewayRequest request)
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.
deleteGateway
in interface AWSIoTSiteWise
deleteGatewayRequest
- 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.
public DeletePortalResult deletePortal(DeletePortalRequest request)
Deletes a portal from AWS IoT SiteWise Monitor.
deletePortal
in interface AWSIoTSiteWise
deletePortalRequest
- 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.public DeleteProjectResult deleteProject(DeleteProjectRequest request)
Deletes a project from AWS IoT SiteWise Monitor.
deleteProject
in interface AWSIoTSiteWise
deleteProjectRequest
- 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.
public DescribeAccessPolicyResult describeAccessPolicy(DescribeAccessPolicyRequest request)
Describes an access policy, which specifies an AWS SSO user or group's access to an AWS IoT SiteWise Monitor portal or project.
describeAccessPolicy
in interface AWSIoTSiteWise
describeAccessPolicyRequest
- 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.
public DescribeAssetResult describeAsset(DescribeAssetRequest request)
Retrieves information about an asset.
describeAsset
in interface AWSIoTSiteWise
describeAssetRequest
- 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.
public DescribeAssetModelResult describeAssetModel(DescribeAssetModelRequest request)
Retrieves information about an asset model.
describeAssetModel
in interface AWSIoTSiteWise
describeAssetModelRequest
- 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.
public DescribeAssetPropertyResult describeAssetProperty(DescribeAssetPropertyRequest request)
Retrieves information about an asset's property.
describeAssetProperty
in interface AWSIoTSiteWise
describeAssetPropertyRequest
- 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.
public DescribeDashboardResult describeDashboard(DescribeDashboardRequest request)
Retrieves information about a dashboard.
describeDashboard
in interface AWSIoTSiteWise
describeDashboardRequest
- 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.
public DescribeGatewayResult describeGateway(DescribeGatewayRequest request)
Retrieves information about a gateway.
describeGateway
in interface AWSIoTSiteWise
describeGatewayRequest
- 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.
public DescribeGatewayCapabilityConfigurationResult describeGatewayCapabilityConfiguration(DescribeGatewayCapabilityConfigurationRequest request)
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.
describeGatewayCapabilityConfiguration
in interface AWSIoTSiteWise
describeGatewayCapabilityConfigurationRequest
- 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.
public DescribeLoggingOptionsResult describeLoggingOptions(DescribeLoggingOptionsRequest request)
Retrieves the current AWS IoT SiteWise logging options.
describeLoggingOptions
in interface AWSIoTSiteWise
describeLoggingOptionsRequest
- 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.public DescribePortalResult describePortal(DescribePortalRequest request)
Retrieves information about a portal.
describePortal
in interface AWSIoTSiteWise
describePortalRequest
- 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.
public DescribeProjectResult describeProject(DescribeProjectRequest request)
Retrieves information about a project.
describeProject
in interface AWSIoTSiteWise
describeProjectRequest
- 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.
public DisassociateAssetsResult disassociateAssets(DisassociateAssetsRequest request)
Disassociates a child asset from the given parent asset through a hierarchy defined in the parent asset's model.
disassociateAssets
in interface AWSIoTSiteWise
disassociateAssetsRequest
- 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.public GetAssetPropertyAggregatesResult getAssetPropertyAggregates(GetAssetPropertyAggregatesRequest request)
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.
getAssetPropertyAggregates
in interface AWSIoTSiteWise
getAssetPropertyAggregatesRequest
- 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.public GetAssetPropertyValueResult getAssetPropertyValue(GetAssetPropertyValueRequest request)
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.
getAssetPropertyValue
in interface AWSIoTSiteWise
getAssetPropertyValueRequest
- 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.public GetAssetPropertyValueHistoryResult getAssetPropertyValueHistory(GetAssetPropertyValueHistoryRequest request)
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.
getAssetPropertyValueHistory
in interface AWSIoTSiteWise
getAssetPropertyValueHistoryRequest
- 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.public ListAccessPoliciesResult listAccessPolicies(ListAccessPoliciesRequest request)
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).
listAccessPolicies
in interface AWSIoTSiteWise
listAccessPoliciesRequest
- 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.
public ListAssetModelsResult listAssetModels(ListAssetModelsRequest request)
Retrieves a paginated list of summaries of all asset models.
listAssetModels
in interface AWSIoTSiteWise
listAssetModelsRequest
- 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.
public ListAssetsResult listAssets(ListAssetsRequest request)
Retrieves a paginated list of asset summaries.
listAssets
in interface AWSIoTSiteWise
listAssetsRequest
- 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.
public ListAssociatedAssetsResult listAssociatedAssets(ListAssociatedAssetsRequest request)
Retrieves a paginated list of the assets associated to a parent asset (assetId
) by a given hierarchy
(hierarchyId
).
listAssociatedAssets
in interface AWSIoTSiteWise
listAssociatedAssetsRequest
- 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.
public ListDashboardsResult listDashboards(ListDashboardsRequest request)
Retrieves a paginated list of dashboards for an AWS IoT SiteWise Monitor project.
listDashboards
in interface AWSIoTSiteWise
listDashboardsRequest
- 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.
public ListGatewaysResult listGateways(ListGatewaysRequest request)
Retrieves a paginated list of gateways.
listGateways
in interface AWSIoTSiteWise
listGatewaysRequest
- 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.
public ListPortalsResult listPortals(ListPortalsRequest request)
Retrieves a paginated list of AWS IoT SiteWise Monitor portals.
listPortals
in interface AWSIoTSiteWise
listPortalsRequest
- 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.
public ListProjectAssetsResult listProjectAssets(ListProjectAssetsRequest request)
Retrieves a paginated list of assets associated with an AWS IoT SiteWise Monitor project.
listProjectAssets
in interface AWSIoTSiteWise
listProjectAssetsRequest
- 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.
public ListProjectsResult listProjects(ListProjectsRequest request)
Retrieves a paginated list of projects for an AWS IoT SiteWise Monitor portal.
listProjects
in interface AWSIoTSiteWise
listProjectsRequest
- 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.
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
Retrieves the list of tags for an AWS IoT SiteWise resource.
listTagsForResource
in interface AWSIoTSiteWise
listTagsForResourceRequest
- 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.public PutLoggingOptionsResult putLoggingOptions(PutLoggingOptionsRequest request)
Sets logging options for AWS IoT SiteWise.
putLoggingOptions
in interface AWSIoTSiteWise
putLoggingOptionsRequest
- 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.public TagResourceResult tagResource(TagResourceRequest request)
Adds tags to an AWS IoT SiteWise resource. If a tag already exists for the resource, this operation updates the tag's value.
tagResource
in interface AWSIoTSiteWise
tagResourceRequest
- 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.public UntagResourceResult untagResource(UntagResourceRequest request)
Removes a tag from an AWS IoT SiteWise resource.
untagResource
in interface AWSIoTSiteWise
untagResourceRequest
- 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.public UpdateAccessPolicyResult updateAccessPolicy(UpdateAccessPolicyRequest request)
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.
updateAccessPolicy
in interface AWSIoTSiteWise
updateAccessPolicyRequest
- 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.
public UpdateAssetResult updateAsset(UpdateAssetRequest request)
Updates an asset's name. For more information, see Updating Assets and Models in the AWS IoT SiteWise User Guide.
updateAsset
in interface AWSIoTSiteWise
updateAssetRequest
- 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.public UpdateAssetModelResult updateAssetModel(UpdateAssetModelRequest request)
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 action overwrites the existing model with the provided model. To avoid deleting your asset model's properties or hierarchies, you must include their 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.
updateAssetModel
in interface AWSIoTSiteWise
updateAssetModelRequest
- 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.public UpdateAssetPropertyResult updateAssetProperty(UpdateAssetPropertyRequest request)
Updates an asset property's alias and notification state.
updateAssetProperty
in interface AWSIoTSiteWise
updateAssetPropertyRequest
- 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.public UpdateDashboardResult updateDashboard(UpdateDashboardRequest request)
Updates an AWS IoT SiteWise Monitor dashboard.
updateDashboard
in interface AWSIoTSiteWise
updateDashboardRequest
- 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.
public UpdateGatewayResult updateGateway(UpdateGatewayRequest request)
Updates a gateway's name.
updateGateway
in interface AWSIoTSiteWise
updateGatewayRequest
- 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.
public UpdateGatewayCapabilityConfigurationResult updateGatewayCapabilityConfiguration(UpdateGatewayCapabilityConfigurationRequest request)
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.
updateGatewayCapabilityConfiguration
in interface AWSIoTSiteWise
updateGatewayCapabilityConfigurationRequest
- 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.
public UpdatePortalResult updatePortal(UpdatePortalRequest request)
Updates an AWS IoT SiteWise Monitor portal.
updatePortal
in interface AWSIoTSiteWise
updatePortalRequest
- 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.public UpdateProjectResult updateProject(UpdateProjectRequest request)
Updates an AWS IoT SiteWise Monitor project.
updateProject
in interface AWSIoTSiteWise
updateProjectRequest
- 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.
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 the request.
getCachedResponseMetadata
in interface AWSIoTSiteWise
request
- The originally executed requestpublic AWSIoTSiteWiseWaiters waiters()
waiters
in interface AWSIoTSiteWise
public void shutdown()
AmazonWebServiceClient
shutdown
in interface AWSIoTSiteWise
shutdown
in class AmazonWebServiceClient
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.