Actions, resources, and condition keys for Amazon IoT SiteWise
Amazon IoT SiteWise (service prefix: iotsitewise) provides the following
service-specific operations, resources, actions, and condition keys for use in IAM permission
policies.
References:
-
Learn how to configure this service.
-
View a list of the API operations available for this service.
-
Learn how to secure this service and its resources by using IAM permission policies.
-
View the programmatic service authorization reference
for this service.
Topics
API operations defined by Amazon IoT SiteWise
The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.
| Operation | IAM action | Condition key | Possible value(s) | Access level |
|---|---|---|---|---|
|
AssociateAssets |
Write |
|||
|
AssociateTimeSeriesToAssetProperty |
Write |
|||
|
BatchAssociateProjectAssets |
Write |
|||
|
BatchDisassociateProjectAssets |
Write |
|||
|
BatchGetAssetPropertyAggregates |
Read |
|||
|
BatchGetAssetPropertyValue |
Read |
|||
|
BatchGetAssetPropertyValueHistory |
Read |
|||
|
BatchPutAssetPropertyValue |
Write |
|||
|
CreateAccessPolicy |
Write |
|||
|
CreateAsset |
Write |
|||
Tagging, Write |
||||
|
CreateAssetModel |
Write |
|||
Tagging, Write |
||||
|
CreateAssetModelCompositeModel |
Write |
|||
iam:PassedToService |
iotsitewise.amazonaws.com |
Write |
||
|
CreateBulkImportJob |
Write |
|||
iam:PassedToService |
iotsitewise.amazonaws.com |
Write |
||
|
CreateComputationModel |
Write |
|||
Tagging, Write |
||||
|
CreateDashboard |
Write |
|||
Tagging, Write |
||||
|
CreateDataset |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
iotsitewise.amazonaws.com |
Write |
||
|
CreateGateway |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
iotsitewise.amazonaws.com |
Write |
||
|
CreatePortal |
Write |
|||
Tagging, Write |
||||
iam:PassedToService |
iotsitewise.amazonaws.com |
Write |
||
|
CreateProject |
Write |
|||
Tagging, Write |
||||
|
DeleteAccessPolicy |
Write |
|||
|
DeleteAsset |
Write |
|||
|
DeleteAssetModel |
Write |
|||
|
DeleteAssetModelCompositeModel |
Write |
|||
|
DeleteAssetModelInterfaceRelationship |
Write |
|||
|
DeleteComputationModel |
Write |
|||
|
DeleteDashboard |
Write |
|||
|
DeleteDataset |
Write |
|||
|
DeleteGateway |
Write |
|||
|
DeletePortal |
Write |
|||
|
DeleteProject |
Write |
|||
|
DeleteTimeSeries |
Write |
|||
|
DescribeAccessPolicy |
Read |
|||
|
DescribeAction |
Read |
|||
|
DescribeAsset |
Read |
|||
|
DescribeAssetCompositeModel |
Read |
|||
|
DescribeAssetModel |
Read |
|||
|
DescribeAssetModelCompositeModel |
Read |
|||
|
DescribeAssetModelInterfaceRelationship |
Read |
|||
|
DescribeAssetProperty |
Read |
|||
|
DescribeBulkImportJob |
Read |
|||
|
DescribeComputationModel |
Read |
|||
|
DescribeComputationModelExecutionSummary |
Read |
|||
|
DescribeDashboard |
Read |
|||
|
DescribeDataset |
Read |
|||
|
DescribeDefaultEncryptionConfiguration |
Read |
|||
|
DescribeExecution |
Read |
|||
|
DescribeGateway |
Read |
|||
|
DescribeGatewayCapabilityConfiguration |
Read |
|||
|
DescribeLoggingOptions |
Read |
|||
|
DescribePortal |
Read |
|||
|
DescribeProject |
Read |
|||
|
DescribeStorageConfiguration |
Read |
|||
|
DescribeTimeSeries |
Read |
|||
|
DisassociateAssets |
Write |
|||
|
DisassociateTimeSeriesFromAssetProperty |
Write |
|||
|
ExecuteAction |
Write |
|||
|
ExecuteQuery |
Read |
|||
|
GetAssetPropertyAggregates |
Read |
|||
|
GetAssetPropertyValue |
Read |
|||
|
GetAssetPropertyValueHistory |
Read |
|||
|
GetInterpolatedAssetPropertyValues |
Read |
|||
|
InvokeAssistant |
Read |
|||
|
ListAccessPolicies |
List |
|||
|
ListActions |
List |
|||
|
ListAssetModelCompositeModels |
List |
|||
|
ListAssetModelProperties |
List |
|||
|
ListAssetModels |
List |
|||
|
ListAssetProperties |
List |
|||
|
ListAssetRelationships |
List |
|||
|
ListAssets |
List |
|||
|
ListAssociatedAssets |
List |
|||
|
ListBulkImportJobs |
List |
|||
|
ListCompositionRelationships |
List |
|||
|
ListComputationModelDataBindingUsages |
List |
|||
|
ListComputationModelResolveToResources |
List |
|||
|
ListComputationModels |
List |
|||
|
ListDashboards |
List |
|||
|
ListDatasets |
List |
|||
|
ListExecutions |
List |
|||
|
ListGateways |
List |
|||
|
ListInterfaceRelationships |
List |
|||
|
ListPortals |
List |
|||
|
ListProjectAssets |
List |
|||
|
ListProjects |
List |
|||
|
ListTagsForResource |
Read |
|||
|
ListTimeSeries |
List |
|||
|
PutAssetModelInterfaceRelationship |
Write |
|||
|
PutDefaultEncryptionConfiguration |
Write |
|||
|
PutLoggingOptions |
Write |
|||
|
PutStorageConfiguration |
Write |
|||
iam:PassedToService |
iotsitewise.amazonaws.com |
Write |
||
|
TagResource |
Tagging, Write |
|||
|
UntagResource |
Tagging, Write |
|||
|
UpdateAccessPolicy |
Write |
|||
|
UpdateAsset |
Write |
|||
|
UpdateAssetModel |
Write |
|||
|
UpdateAssetModelCompositeModel |
Write |
|||
iam:PassedToService |
iotsitewise.amazonaws.com |
Write |
||
|
UpdateAssetProperty |
Write |
|||
|
UpdateComputationModel |
Write |
|||
|
UpdateDashboard |
Write |
|||
|
UpdateDataset |
Write |
|||
iam:PassedToService |
iotsitewise.amazonaws.com |
Write |
||
|
UpdateGateway |
Write |
|||
|
UpdateGatewayCapabilityConfiguration |
Write |
|||
|
UpdatePortal |
Write |
|||
iam:PassedToService |
iotsitewise.amazonaws.com |
Write |
||
|
UpdateProject |
Write |
Actions defined by Amazon IoT SiteWise
You can specify the following actions in the Action element of an IAM
policy statement. Use policies to grant permissions to perform an operation in Amazon. When
you use an action in a policy, you usually allow or deny access to the API operation or CLI
command with the same name. However, in some cases, a single action controls access to more
than one operation. Alternatively, some operations require several different actions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to associate a child asset with a parent asset through a hierarchy |
Write |
|||
Grants permission to associate a time series with an asset property |
Write |
|||
Grants permission to associate assets to a project |
Write |
|||
Grants permission to disassociate assets from a project |
Write |
|||
Grants permission to retrieve computed aggregates for multiple asset properties |
Read |
|||
Grants permission to retrieve the latest value for multiple asset properties |
Read |
|||
Grants permission to retrieve the value history for multiple asset properties |
Read |
|||
Grants permission to put property values for asset properties |
Write |
|||
Grants permission to create an access policy for a portal or a project |
Write |
|||
Grants permission to create an asset from an asset model |
Write |
|||
Grants permission to create an asset model |
Write |
|||
Grants permission to create an asset model composite model inside an asset model |
Write |
|||
Grants permission to create bulk import job |
Write |
|||
Grants permission to create a computation model |
Write |
|||
Grants permission to create a dashboard in a project |
Write |
|||
Grants permission to create a dataset |
Write |
|||
Grants permission to create a gateway |
Write |
|||
Grants permission to create a portal |
Write |
|||
Grants permission to create a project in a portal |
Write |
|||
Grants permission to delete an access policy |
Write |
|||
Grants permission to delete an asset |
Write |
|||
Grants permission to delete an asset model |
Write |
|||
Grants permission to delete an asset model composite model |
Write |
|||
Grants permission to delete a relationship between asset model and interface |
Write |
|||
Grants permission to delete a computation model |
Write |
|||
Grants permission to delete a dashboard |
Write |
|||
Grants permission to delete a dataset |
Write |
|||
Grants permission to delete a gateway |
Write |
|||
Grants permission to delete a portal |
Write |
|||
Grants permission to delete a project |
Write |
|||
Grants permission to delete a time series |
Write |
|||
Grants permission to describe an access policy |
Read |
|||
Grants permission to describe actions |
Read |
|||
Grants permission to describe an asset |
Read |
|||
Grants permission to describe an asset composite model |
Read |
|||
Grants permission to describe an asset model |
Read |
|||
Grants permission to describe an asset model composite model |
Read |
|||
Grants permission to describe a relationship between asset model and interface |
Read |
|||
Grants permission to describe an asset property |
Read |
|||
Grants permission to describe bulk import job |
Read |
|||
Grants permission to describe a computation model |
Read |
|||
Grants permission to describe computation model execution summary |
Read |
|||
Grants permission to describe a dashboard |
Read |
|||
Grants permission to describe dataset |
Read |
|||
Grants permission to describe the default encryption configuration for the Amazon Web Services account |
Read |
|||
Grants permission to describe an execution |
Read |
|||
Grants permission to describe a gateway |
Read |
|||
Grants permission to describe a capability configuration for a gateway |
Read |
|||
Grants permission to describe logging options for the Amazon Web Services account |
Read |
|||
Grants permission to describe a portal |
Read |
|||
Grants permission to describe a project |
Read |
|||
Grants permission to describe the storage configuration for the Amazon Web Services account |
Read |
|||
Grants permission to describe a time series |
Read |
|||
Grants permission to disassociate a child asset from a parent asset by a hierarchy |
Write |
|||
Grants permission to disassociate a time series from an asset property |
Write |
|||
Grants permission to execute actions |
Write |
|||
Grants permission to execute query |
Read |
|||
Grants permission to retrieve computed aggregates for an asset property |
Read |
|||
Grants permission to retrieve the latest value for an asset property |
Read |
|||
Grants permission to retrieve the value history for an asset property |
Read |
|||
Grants permission to retrieve interpolated values for an asset property |
Read |
|||
Grants permission to invoke an assistant |
Read |
|||
Grants permission to list all access policies for an identity or a resource |
List |
|||
Grants permission to list all actions |
List |
|||
Grants permission to list all asset model composite models |
List |
|||
Grants permission to list asset model properties |
List |
|||
Grants permission to list all asset models |
List |
|||
Grants permission to list asset properties |
List |
|||
Grants permission to list the asset relationship graph for an asset |
List |
|||
Grants permission to list all assets |
List |
|||
Grants permission to list all assets associated with an asset through a hierarchy |
List |
|||
Grants permission to list bulk import jobs |
List |
|||
Grants permission to list all asset model composition relationships |
List |
|||
Grants permission to list computation model data binding usages |
List |
|||
Grants permission to list computation model resolve to resources |
List |
|||
Grants permission to list all computation models |
List |
|||
Grants permission to list all dashboards in a project |
List |
|||
Grants permission to list all datasets |
List |
|||
Grants permission to list executions |
List |
|||
Grants permission to list all gateways |
List |
|||
Grants permission to list all asset models that are enforced by an interface |
List |
|||
Grants permission to list all portals |
List |
|||
Grants permission to list all assets associated with a project |
List |
|||
Grants permission to list all projects in a portal |
List |
|||
Grants permission to list all tags for a resource |
Read |
|||
Grants permission to list time series |
List |
|||
Grants permission to create a relationship between asset model and interface |
Write |
|||
Grants permission to set the default encryption configuration for the Amazon Web Services account |
Write |
|||
Grants permission to set logging options for the Amazon Web Services account |
Write |
|||
Grants permission to configure storage settings for the Amazon Web Services account |
Write |
|||
Grants permission to tag a resource |
Tagging, Write |
|||
Grants permission to untag a resource |
Tagging, Write |
|||
Grants permission to update an access policy |
Write |
|||
Grants permission to update an asset |
Write |
|||
Grants permission to update an asset model |
Write |
|||
Grants permission to update asset model composite model |
Write |
|||
Grants permission to update an asset property |
Write |
|||
Grants permission to update a computation model |
Write |
|||
Grants permission to update a dashboard |
Write |
|||
Grants permission to update a dataset |
Write |
|||
Grants permission to update a gateway |
Write |
|||
Grants permission to update a capability configuration for a gateway |
Write |
|||
Grants permission to update a portal |
Write |
|||
Grants permission to update a project |
Write |
Permission-only actions for Amazon IoT SiteWise
The following actions are defined by Amazon IoT SiteWise but are not directly invocable through any API operation. They can only be used in IAM policy statements to grant or deny permissions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to allow IoT SiteWise integrate with other services |
Write |
|||
Grants permission to update an AssetModel property routing |
Write |
Resource types defined by Amazon IoT SiteWise
The following resource types are defined by this service and can be used in the
Resource element of IAM permission policy statements.
| Resource types | ARN | Condition keys |
|---|---|---|
arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId} |
||
arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId} |
||
arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId} |
||
arn:${Partition}:iotsitewise:${Region}:${Account}:computation-model/${ComputationModelId} |
||
arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId} |
||
arn:${Partition}:iotsitewise:${Region}:${Account}:dataset/${DatasetId} |
||
arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId} |
||
arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId} |
||
arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId} |
||
arn:${Partition}:iotsitewise:${Region}:${Account}:time-series/${TimeSeriesId} |
Condition keys for Amazon IoT SiteWise
Amazon IoT SiteWise defines the following condition keys that can be used in the
Condition element of an IAM policy.
| Condition keys | Description | Type |
|---|---|---|
Filters access by the tag key-value pairs in the request |
String |
|
Filters access by the tags attached to the resource |
String |
|
Filters access by the tag keys in the request |
ArrayOfString |
|
Filters access by an asset hierarchy path, which is the string of asset IDs in the asset's hierarchy, each separated by a forward slash |
String |
|
Filters access by the ID of a child asset being associated whith a parent asset |
String |
|
Filters access by the ID of an Amazon Single Sign-On group |
String |
|
Filters access by the ID of an Amazon IAM identity |
String |
|
Filters access by data streams associated with or not associated with asset properties |
String |
|
Filters access by the ID of a portal |
String |
|
Filters access by the ID of a project |
String |
|
Filters access by the property alias |
String |
|
Filters access by the ID of an asset property |
String |
|
Filters access by the ID of an Amazon Single Sign-On user |
String |