Actions, resources, and condition keys for AWS IoT SiteWise - AWS Identity and Access Management

Actions, resources, and condition keys for AWS IoT SiteWise

Tip

This page is moving to a new location on November 16, 2020. Please update your bookmark to use the new page at https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiotsitewise.html.

AWS IoT SiteWise (service prefix: iotsitewise) provides the following service-specific resources, actions, and condition context keys for use in IAM permission policies.

References:

Actions defined by AWS 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 AWS. 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.

The Resource types column indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") in the Resource element of your policy statement. If the column includes a resource type, then you can specify an ARN of that type in a statement with that action. Required resources are indicated in the table with an asterisk (*). If you specify a resource-level permission ARN in a statement using this action, then it must be of this type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one but not the other.

For details about the columns in the following table, see The actions table.

Actions Description Access level Resource types (*required) Condition keys Dependent actions
AssociateAssets Grants permission to associate a child asset to a parent asset by a hierarchy Write

asset*

BatchAssociateProjectAssets Grants permission to associate assets to a project Write

project*

BatchDisassociateProjectAssets Grants permission to disassociate assets from a project Write

project*

BatchPutAssetPropertyValue Grants permission to put property values for asset properties Write

asset*

CreateAccessPolicy Grants permission to create an access policy for a portal or a project Permissions management

portal

project

aws:RequestTag/${TagKey}

aws:TagKeys

CreateAsset Grants permission to create an asset from an asset model Write

asset-model*

aws:RequestTag/${TagKey}

aws:TagKeys

CreateAssetModel Grants permission to create an asset model Write

aws:RequestTag/${TagKey}

aws:TagKeys

CreateDashboard Grants permission to create a dashboard in a project Write

project*

aws:RequestTag/${TagKey}

aws:TagKeys

CreateGateway Grants permission to create a gateway Write

aws:RequestTag/${TagKey}

aws:TagKeys

CreatePortal Grants permission to create a portal Write

aws:RequestTag/${TagKey}

aws:TagKeys

sso:CreateManagedApplicationInstance

sso:DescribeRegisteredRegions

CreateProject Grants permission to create a project in a portal Write

portal*

aws:RequestTag/${TagKey}

aws:TagKeys

DeleteAccessPolicy Grants permission to delete an access policy Permissions management

access-policy*

DeleteAsset Grants permission to delete an asset Write

asset*

DeleteAssetModel Grants permission to delete an asset model Write

asset-model*

DeleteDashboard Grants permission to delete a dashboard Write

dashboard*

DeleteGateway Grants permission to delete a gateway Write

gateway*

DeletePortal Grants permission to delete a portal Write

portal*

sso:DeleteManagedApplicationInstance

DeleteProject Grants permission to delete a project Write

project*

DescribeAccessPolicy Grants permission to describe an access policy Permissions management

access-policy*

DescribeAsset Grants permission to describe an asset Read

asset*

DescribeAssetModel Grants permission to describe an asset model Read

asset-model*

DescribeAssetProperty Grants permission to describe an asset property Read

asset*

DescribeDashboard Grants permission to describe a dashboard Read

dashboard*

DescribeGateway Grants permission to describe a gateway Read

gateway*

DescribeGatewayCapabilityConfiguration Grants permission to describe a capability configuration for a gateway Read

gateway*

DescribeLoggingOptions Grants permission to describe logging options for the AWS account Read
DescribePortal Grants permission to describe a portal Read

portal*

DescribeProject Grants permission to describe a project Read

project*

DisassociateAssets Grants permission to disassociate a child asset from a parent asset by a hierarchy Write

asset*

GetAssetPropertyAggregates Grants permission to retrieve computed aggregates for an asset property Read

asset*

GetAssetPropertyValue Grants permission to retrieve the latest value for an asset property Read

asset*

GetAssetPropertyValueHistory Grants permission to retrieve the value history for an asset property Read

asset*

ListAccessPolicies Grants permission to list all access policies for an identity or a resource Permissions management

portal

project

ListAssetModels Grants permission to list all asset models List
ListAssets Grants permission to list all assets List

asset-model

ListAssociatedAssets Grants permission to list all assets associated to an asset by a hierarchy List

asset*

ListDashboards Grants permission to list all dashboards in a project List

project*

ListGateways Grants permission to list all gateways List
ListPortals Grants permission to list all portals List
ListProjectAssets Grants permission to list all assets associated with a project List

project*

ListProjects Grants permission to list all projects in a portal List

portal*

ListTagsForResource Grants permission to list all tags for a resource Read

access-policy

asset

asset-model

dashboard

gateway

portal

project

aws:ResourceTag/${TagKey}

PutLoggingOptions Grants permission to set logging options for the AWS account Write
TagResource Grants permission to tag a resource Tagging

access-policy

asset

asset-model

dashboard

gateway

portal

project

aws:TagKeys

aws:RequestTag/${TagKey}

UntagResource Grants permission to untag a resource Tagging

access-policy

asset

asset-model

dashboard

gateway

portal

project

aws:TagKeys

UpdateAccessPolicy Grants permission to update an access policy Permissions management

access-policy*

UpdateAsset Grants permission to update an asset Write

asset*

UpdateAssetModel Grants permission to update an asset model Write

asset-model*

UpdateAssetProperty Grants permission to update an asset property Write

asset*

UpdateDashboard Grants permission to update a dashboard Write

dashboard*

UpdateGateway Grants permission to update a gateway Write

gateway*

UpdateGatewayCapabilityConfiguration Grants permission to update a capability configuration for a gateway Write

gateway*

UpdatePortal Grants permission to update a portal Write

portal*

UpdateProject Grants permission to update a project Write

project*

Resource types defined by AWS IoT SiteWise

The following resource types are defined by this service and can be used in the Resource element of IAM permission policy statements. Each action in the Actions table identifies the resource types that can be specified with that action. A resource type can also define which condition keys you can include in a policy. These keys are displayed in the last column of the table. For details about the columns in the following table, see The resource types table.

Resource types ARN Condition keys
asset arn:${Partition}:iotsitewise:${Region}:${Account}:asset/${AssetId}

aws:ResourceTag/${TagKey}

asset-model arn:${Partition}:iotsitewise:${Region}:${Account}:asset-model/${AssetModelId}

aws:ResourceTag/${TagKey}

gateway arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}

aws:ResourceTag/${TagKey}

portal arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

aws:ResourceTag/${TagKey}

project arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}

aws:ResourceTag/${TagKey}

dashboard arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}

aws:ResourceTag/${TagKey}

access-policy arn:${Partition}:iotsitewise:${Region}:${Account}:access-policy/${AccessPolicyId}

aws:ResourceTag/${TagKey}

Condition keys for AWS IoT SiteWise

AWS IoT SiteWise defines the following condition keys that can be used in the Condition element of an IAM policy. You can use these keys to further refine the conditions under which the policy statement applies. For details about the columns in the following table, see The condition keys table.

To view the global condition keys that are available to all services, see Available global condition keys.

Condition keys Description Type
aws:RequestTag/${TagKey} Filters access by the tag key-value pairs in the request String
aws:ResourceTag/${TagKey} Filters access by the tags attached to the resource String
aws:TagKeys Filters actions by the tag keys in the request String
iotsitewise:assetHierarchyPath 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
iotsitewise:childAssetId Filters access by the ID of a child asset being associated to a parent asset String
iotsitewise:group Filters access by the ID of an AWS Single Sign-On group String
iotsitewise:portal Filters access by the ID of a portal String
iotsitewise:project Filters access by the ID of a project String
iotsitewise:propertyId Filters access by the ID of an asset property String
iotsitewise:user Filters access by the ID of an AWS Single Sign-On user String