Actions, resources, and condition keys for AWS IoT TwinMaker - Service Authorization Reference

Actions, resources, and condition keys for AWS IoT TwinMaker

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

References:

Actions defined by AWS 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 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 of the Actions table indicates whether each action supports resource-level permissions. If there is no value for this column, you must specify all resources ("*") to which the policy applies 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. If the action has one or more required resources, the caller must have permission to use the action with those resources. Required resources are indicated in the table with an asterisk (*). If you limit resource access with the Resource element in an IAM policy, you must include an ARN or pattern for each required resource type. Some actions support multiple resource types. If the resource type is optional (not indicated as required), then you can choose to use one of the optional resource types.

The Condition keys column of the Actions table includes keys that you can specify in a policy statement's Condition element. For more information on the condition keys that are associated with resources for the service, see the Condition keys column of the Resource types table.

Note

Resource condition keys are listed in the Resource types table. You can find a link to the resource type that applies to an action in the Resource types (*required) column of the Actions table. The resource type in the Resource types table includes the Condition keys column, which are the resource condition keys that apply to an action in the Actions table.

For details about the columns in the following table, see Actions table.

Actions Description Access level Resource types (*required) Condition keys Dependent actions
BatchPutPropertyValues Grants permission to set values for multiple time series properties Write

workspace*

iottwinmaker:GetComponentType

iottwinmaker:GetEntity

iottwinmaker:GetWorkspace

entity

CancelMetadataTransferJob Grants permission to cancel a metadata transfer job Write

metadataTransferJob*

CreateComponentType Grants permission to create a componentType Write

workspace*

aws:RequestTag/${TagKey}

aws:TagKeys

CreateEntity Grants permission to create an entity Write

workspace*

aws:RequestTag/${TagKey}

aws:TagKeys

CreateMetadataTransferJob Grants permission to create a metadata transfer job Write
CreateScene Grants permission to create a scene Write

workspace*

aws:RequestTag/${TagKey}

aws:TagKeys

CreateSyncJob Grants permission to create a sync job Write

workspace*

aws:RequestTag/${TagKey}

aws:TagKeys

CreateWorkspace Grants permission to create a workspace Write

aws:RequestTag/${TagKey}

aws:TagKeys

DeleteComponentType Grants permission to delete a componentType Write

componentType*

workspace*

DeleteEntity Grants permission to delete an entity Write

entity*

workspace*

DeleteScene Grants permission to delete a scene Write

scene*

workspace*

DeleteSyncJob Grants permission to delete a sync job Write

syncJob*

workspace*

DeleteWorkspace Grants permission to delete a workspace Write

workspace*

ExecuteQuery Grants permission to execute query Read

workspace*

GetComponentType Grants permission to get a componentType Read

componentType*

workspace*

GetEntity Grants permission to get an entity Read

entity*

workspace*

GetMetadataTransferJob Grants permission to get a metadata transfer job Read

metadataTransferJob*

GetPricingPlan Grants permission to get pricing plan Read
GetPropertyValue Grants permission to retrieve the property values Read

workspace*

iottwinmaker:GetComponentType

iottwinmaker:GetEntity

iottwinmaker:GetWorkspace

componentType

entity

GetPropertyValueHistory Grants permission to retrieve the time series value history Read

workspace*

iottwinmaker:GetComponentType

iottwinmaker:GetEntity

iottwinmaker:GetWorkspace

componentType

entity

GetScene Grants permission to get a scene Read

scene*

workspace*

GetSyncJob Grants permission to get a sync job Read

syncJob*

workspace*

GetWorkspace Grants permission to get a workspace Read

workspace*

ListComponentTypes Grants permission to list all componentTypes in a workspace List

workspace*

ListComponents Grants permission to list components attached to an entity List

entity*

workspace*

ListEntities Grants permission to list all entities in a workspace List

workspace*

ListMetadataTransferJobs Grants permission to list all metadata transfer jobs List
ListProperties Grants permission to list properties of an entity component List

entity*

workspace*

ListScenes Grants permission to list all scenes in a workspace List

workspace*

ListSyncJobs Grants permission to list all sync jobs in a workspace List

workspace*

ListSyncResources Grants permission to list all sync resources for a sync job List

syncJob*

workspace*

ListTagsForResource Grants permission to list all tags for a resource List

componentType

entity

scene

syncJob

workspace

aws:ResourceTag/${TagKey}

ListWorkspaces Grants permission to list all workspaces List
TagResource Grants permission to tag a resource Tagging

componentType

entity

scene

syncJob

workspace

aws:RequestTag/${TagKey}

aws:TagKeys

UntagResource Grants permission to untag a resource Tagging

componentType

entity

scene

syncJob

workspace

aws:TagKeys

UpdateComponentType Grants permission to update a componentType Write

componentType*

workspace*

UpdateEntity Grants permission to update an entity Write

entity*

workspace*

UpdatePricingPlan Grants permission to update pricing plan Write
UpdateScene Grants permission to update a scene Write

scene*

workspace*

UpdateWorkspace Grants permission to update a workspace Write

workspace*

Resource types defined by AWS IoT TwinMaker

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 Resource types table. For details about the columns in the following table, see Resource types table.

Resource types ARN Condition keys
workspace arn:${Partition}:iottwinmaker:${Region}:${Account}:workspace/${WorkspaceId}

aws:ResourceTag/${TagKey}

entity arn:${Partition}:iottwinmaker:${Region}:${Account}:workspace/${WorkspaceId}/entity/${EntityId}

aws:ResourceTag/${TagKey}

componentType arn:${Partition}:iottwinmaker:${Region}:${Account}:workspace/${WorkspaceId}/component-type/${ComponentTypeId}

aws:ResourceTag/${TagKey}

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}

metadataTransferJob arn:${Partition}:iottwinmaker:${Region}:${Account}:metadata-transfer-job/${MetadataTransferJobId}

Condition keys for AWS IoT TwinMaker

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