Operations Actions Resource types Condition keys

Actions, resources, and condition keys for Amazon IoT TwinMaker

Amazon IoT TwinMaker (service prefix: iottwinmaker) 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 TwinMaker
Actions defined by Amazon IoT TwinMaker
Resource types defined by Amazon IoT TwinMaker
Condition keys for Amazon IoT TwinMaker

API operations defined by Amazon IoT TwinMaker

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
BatchPutPropertyValues	iottwinmaker:BatchPutPropertyValues			Write
CancelMetadataTransferJob	iottwinmaker:CancelMetadataTransferJob			Write
CreateComponentType	iottwinmaker:CreateComponentType			Write
CreateComponentType	iottwinmaker:TagResource			Tagging, Write
CreateEntity	iottwinmaker:CreateEntity			Write
CreateEntity	iottwinmaker:TagResource			Tagging, Write
CreateMetadataTransferJob	iottwinmaker:CreateMetadataTransferJob			Write
CreateScene	iottwinmaker:CreateScene			Write
CreateScene	iottwinmaker:TagResource			Tagging, Write
CreateSyncJob	iottwinmaker:CreateSyncJob			Write
	iottwinmaker:TagResource			Tagging, Write
	iam:PassRole	iam:PassedToService	iottwinmaker.amazonaws.com	Write
CreateWorkspace	iottwinmaker:CreateWorkspace			Write
	iottwinmaker:TagResource			Tagging, Write
	iam:PassRole	iam:PassedToService	iottwinmaker.amazonaws.com	Write
DeleteComponentType	iottwinmaker:DeleteComponentType			Write
DeleteEntity	iottwinmaker:DeleteEntity			Write
DeleteScene	iottwinmaker:DeleteScene			Write
DeleteSyncJob	iottwinmaker:DeleteSyncJob			Write
DeleteWorkspace	iottwinmaker:DeleteWorkspace			Write
ExecuteQuery	iottwinmaker:ExecuteQuery			Read
GetComponentType	iottwinmaker:GetComponentType			Read
GetEntity	iottwinmaker:GetEntity			Read
GetMetadataTransferJob	iottwinmaker:GetMetadataTransferJob			Read
GetPricingPlan	iottwinmaker:GetPricingPlan			Read
GetPropertyValue	iottwinmaker:GetPropertyValue			Read
GetPropertyValueHistory	iottwinmaker:GetPropertyValueHistory			Read
GetScene	iottwinmaker:GetScene			Read
GetSyncJob	iottwinmaker:GetSyncJob			Read
GetWorkspace	iottwinmaker:GetWorkspace			Read
ListComponentTypes	iottwinmaker:ListComponentTypes			List
ListComponents	iottwinmaker:ListComponents			List
ListEntities	iottwinmaker:ListEntities			List
ListMetadataTransferJobs	iottwinmaker:ListMetadataTransferJobs			List
ListProperties	iottwinmaker:ListProperties			List
ListScenes	iottwinmaker:ListScenes			List
ListSyncJobs	iottwinmaker:ListSyncJobs			List
ListSyncResources	iottwinmaker:ListSyncResources			List
ListTagsForResource	iottwinmaker:ListTagsForResource			List
ListWorkspaces	iottwinmaker:ListWorkspaces			List
TagResource	iottwinmaker:TagResource			Tagging, Write
UntagResource	iottwinmaker:UntagResource			Tagging, Write
UpdateComponentType	iottwinmaker:UpdateComponentType			Write
UpdateEntity	iottwinmaker:UpdateEntity			Write
UpdatePricingPlan	iottwinmaker:UpdatePricingPlan			Write
UpdateScene	iottwinmaker:UpdateScene			Write
UpdateWorkspace	iottwinmaker:UpdateWorkspace			Write

Actions defined by Amazon IoT TwinMaker

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
BatchPutPropertyValues	Grants permission to set values for multiple time series properties	entity	aws:ResourceTag/${TagKey}	Write
BatchPutPropertyValues		workspace*	aws:ResourceTag/${TagKey}	Write
CancelMetadataTransferJob	Grants permission to cancel a metadata transfer job	metadataTransferJob*		Write
CreateComponentType	Grants permission to create a componentType	workspace*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
CreateEntity	Grants permission to create an entity	workspace*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
CreateMetadataTransferJob	Grants permission to create a metadata transfer job			Write
CreateScene	Grants permission to create a scene	workspace*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
CreateSyncJob	Grants permission to create a sync job	workspace*	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Write
CreateWorkspace	Grants permission to create a workspace		aws:RequestTag/${TagKey} aws:TagKeys	Write
DeleteComponentType	Grants permission to delete a componentType	componentType*	aws:ResourceTag/${TagKey}	Write
DeleteComponentType	Grants permission to delete a componentType	workspace*	aws:ResourceTag/${TagKey}	Write
DeleteEntity	Grants permission to delete an entity	entity*	aws:ResourceTag/${TagKey}	Write
DeleteEntity	Grants permission to delete an entity	workspace*	aws:ResourceTag/${TagKey}	Write
DeleteScene	Grants permission to delete a scene	scene*	aws:ResourceTag/${TagKey}	Write
DeleteScene	Grants permission to delete a scene	workspace*	aws:ResourceTag/${TagKey}	Write
DeleteSyncJob	Grants permission to delete a sync job	syncJob*	aws:ResourceTag/${TagKey}	Write
DeleteSyncJob	Grants permission to delete a sync job	workspace*	aws:ResourceTag/${TagKey}	Write
DeleteWorkspace	Grants permission to delete a workspace	workspace*	aws:ResourceTag/${TagKey}	Write
ExecuteQuery	Grants permission to execute query	workspace*	aws:ResourceTag/${TagKey}	Read
GetComponentType	Grants permission to get a componentType	componentType*	aws:ResourceTag/${TagKey}	Read
GetComponentType	Grants permission to get a componentType	workspace*	aws:ResourceTag/${TagKey}	Read
GetEntity	Grants permission to get an entity	entity*	aws:ResourceTag/${TagKey}	Read
GetEntity	Grants permission to get an entity	workspace*	aws:ResourceTag/${TagKey}	Read
GetMetadataTransferJob	Grants permission to get a metadata transfer job	metadataTransferJob*		Read
GetPricingPlan	Grants permission to get pricing plan			Read
GetPropertyValue	Grants permission to retrieve the property values	componentType	aws:ResourceTag/${TagKey}	Read
		entity	aws:ResourceTag/${TagKey}
		workspace*	aws:ResourceTag/${TagKey}
GetPropertyValueHistory	Grants permission to retrieve the time series value history	componentType	aws:ResourceTag/${TagKey}	Read
		entity	aws:ResourceTag/${TagKey}
		workspace*	aws:ResourceTag/${TagKey}
GetScene	Grants permission to get a scene	scene*	aws:ResourceTag/${TagKey}	Read
GetScene	Grants permission to get a scene	workspace*	aws:ResourceTag/${TagKey}	Read
GetSyncJob	Grants permission to get a sync job	syncJob*	aws:ResourceTag/${TagKey}	Read
GetSyncJob	Grants permission to get a sync job	workspace*	aws:ResourceTag/${TagKey}	Read
GetWorkspace	Grants permission to get a workspace	workspace*	aws:ResourceTag/${TagKey}	Read
ListComponentTypes	Grants permission to list all componentTypes in a workspace	workspace*	aws:ResourceTag/${TagKey}	List
ListComponents	Grants permission to list components attached to an entity	entity*	aws:ResourceTag/${TagKey}	List
ListComponents	Grants permission to list components attached to an entity	workspace*	aws:ResourceTag/${TagKey}	List
ListEntities	Grants permission to list all entities in a workspace	workspace*	aws:ResourceTag/${TagKey}	List
ListMetadataTransferJobs	Grants permission to list all metadata transfer jobs			List
ListProperties	Grants permission to list properties of an entity component	entity*	aws:ResourceTag/${TagKey}	List
ListProperties	Grants permission to list properties of an entity component	workspace*	aws:ResourceTag/${TagKey}	List
ListScenes	Grants permission to list all scenes in a workspace	workspace*	aws:ResourceTag/${TagKey}	List
ListSyncJobs	Grants permission to list all sync jobs in a workspace	workspace*	aws:ResourceTag/${TagKey}	List
ListSyncResources	Grants permission to list all sync resources for a sync job	syncJob*	aws:ResourceTag/${TagKey}	List
ListSyncResources	Grants permission to list all sync resources for a sync job	workspace*	aws:ResourceTag/${TagKey}	List
ListTagsForResource	Grants permission to list all tags for a resource	componentType	aws:ResourceTag/${TagKey}	List
		entity	aws:ResourceTag/${TagKey}
		scene	aws:ResourceTag/${TagKey}
		syncJob	aws:ResourceTag/${TagKey}
		workspace	aws:ResourceTag/${TagKey}
ListWorkspaces	Grants permission to list all workspaces			List
TagResource	Grants permission to tag a resource	componentType	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys	Tagging, Write
		entity	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys
		scene	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys
		syncJob	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys
		workspace	aws:RequestTag/${TagKey} aws:ResourceTag/${TagKey} aws:TagKeys
UntagResource	Grants permission to untag a resource	componentType	aws:ResourceTag/${TagKey} aws:TagKeys	Tagging, Write
		entity	aws:ResourceTag/${TagKey} aws:TagKeys
		scene	aws:ResourceTag/${TagKey} aws:TagKeys
		syncJob	aws:ResourceTag/${TagKey} aws:TagKeys
		workspace	aws:ResourceTag/${TagKey} aws:TagKeys
UpdateComponentType	Grants permission to update a componentType	componentType*	aws:ResourceTag/${TagKey}	Write
UpdateComponentType	Grants permission to update a componentType	workspace*	aws:ResourceTag/${TagKey}	Write
UpdateEntity	Grants permission to update an entity	entity*	aws:ResourceTag/${TagKey}	Write
UpdateEntity	Grants permission to update an entity	workspace*	aws:ResourceTag/${TagKey}	Write
UpdatePricingPlan	Grants permission to update pricing plan			Write
UpdateScene	Grants permission to update a scene	scene*	aws:ResourceTag/${TagKey}	Write
UpdateScene	Grants permission to update a scene	workspace*	aws:ResourceTag/${TagKey}	Write
UpdateWorkspace	Grants permission to update a workspace	workspace*	aws:ResourceTag/${TagKey}	Write

Resource types defined by Amazon IoT TwinMaker

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
componentType	arn:${Partition}:iottwinmaker:${Region}:${Account}:workspace/${WorkspaceId}/component-type/${ComponentTypeId}	aws:ResourceTag/${TagKey}
entity	arn:${Partition}:iottwinmaker:${Region}:${Account}:workspace/${WorkspaceId}/entity/${EntityId}	aws:ResourceTag/${TagKey}
metadataTransferJob	arn:${Partition}:iottwinmaker:${Region}:${Account}:metadata-transfer-job/${MetadataTransferJobId}
scene	arn:${Partition}:iottwinmaker:${Region}:${Account}:workspace/${WorkspaceId}/scene/${SceneId}	aws:ResourceTag/${TagKey}
syncJob	arn:${Partition}:iottwinmaker:${Region}:${Account}:workspace/${WorkspaceId}/sync-job/${SyncJobId}	aws:ResourceTag/${TagKey}
workspace	arn:${Partition}:iottwinmaker:${Region}:${Account}:workspace/${WorkspaceId}	aws:ResourceTag/${TagKey}

Condition keys for Amazon IoT TwinMaker

Amazon IoT TwinMaker defines the following condition keys that can be used in the Condition element of an IAM policy.

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 access by the tag keys in the request	ArrayOfString
iottwinmaker:destinationType	Filters access by destination type of metadata transfer job	String
iottwinmaker:linkedServices	Filters access by workspace linked to services	ArrayOfString
iottwinmaker:sourceType	Filters access by source type of metadata transfer job	String

Javascript is disabled or is unavailable in your browser.

To use the Amazon Web Services Documentation, Javascript must be enabled. Please refer to your browser's Help pages for instructions.

Amazon IoT SiteWise (iotsitewise)

Amazon Key Management Service (kms)