How Amazon IoT Analytics works with IAM
Before you use IAM to manage access to Amazon IoT Analytics, you should understand what IAM features are available to use with Amazon IoT Analytics. To get a high-level view of how Amazon IoT Analytics and other Amazon services work with IAM, see Amazon services that work with IAM in the IAM User Guide.
Topics on this page:
Amazon IoT Analytics identity-based policies
With IAM identity-based policies, you can specify allowed or denied actions and resources and the conditions under which actions are allowed or denied. Amazon IoT Analytics supports specific actions, resources, and condition keys. To learn about all of the elements that you use in a JSON policy, see IAM JSON policy elements reference in the IAM User Guide.
Actions
The Action
element of an IAM identity-based policy describes the specific
action or actions that will be allowed or denied by the policy. Policy actions usually have
the same name as the associated Amazon API operation. The actions is used in a policy to grant
permissions to perform the associated operation.
Policy action in Amazon IoT Analytics use the following prefix before the action:
iotanalytics:
For example, to grant someone permission to create an Amazon IoT Analytics
channel with the Amazon IoT Analytics CreateChannel
API operation, you include the
iotanalytics:BatchPuMessage
action in their policy. Policy statements must
include either an Action
or NotAction
element. Amazon IoT Analytics defines its own
set of actions that describe tasks that you can perform with this service.
To specify multiple actions in a single statement, separate them with commas as follows.
"Action": [ "iotanalytics:action1", "iotanalytics:action2" ]
You can specify multiple actions using wildcards (*). For example, to specify all actions
that begin with the word Describe
, include the following action.
"Action": "iotanalytics:Describe*"
To see a list of Amazon IoT Analytics actions, see Actions defined by Amazon IoT Analytics in the IAM User Guide.
Resources
The Resource
element specifies the object or objects to which the action
applies. Statements must include either a Resource
or a NotResource
element. You specify a resource using an ARN or using the wildcard (*) to indicate that the
statement applies to all resources.
The Amazon IoT Analytics dataset resource has the following ARN.
arn:${Partition}:iotanalytics:${Region}:${Account}:dataset/${DatasetName}
For more information about the format of ARNs, see Amazon Resource Names (ARNs) and Amazon service namespaces.
For example, to specify the Foobar
dataset in your statement, use the
following ARN.
"Resource": "arn:aws-cn:iotanalytics:us-east-1:123456789012:dataset/Foobar"
To specify all instances that belong to a specific account, use the wildcard (*).
"Resource": "arn:aws-cn:iotanalytics:us-east-1:123456789012:dataset/*"
Some Amazon IoT Analytics actions, such as those for creating resources, cannot be performed on a specific resource. In those cases, you must use the wildcard (*).
"Resource": "*"
Some Amazon IoT Analytics API actions involve multiple resources. For example,
CreatePipeline
references as a channel and a dataset, so a user must have
permissions to use the channel and the dataset. To specify multiple resources in a single
statement, separate the ARNs with commas.
"Resource": [ "resource1", "resource2" ]
To see a list of Amazon IoT Analytics resource types and their ARNs, see Resources defined by Amazon IoT Analytics in the IAM User Guide. To learn with which actions you can specify the ARN of each resource, see Actions defined by Amazon IoT Analytics.
Condition keys
The Condition
element (or Condition
block) lets you specify conditions in which a statement is in effect. The
Condition
element is optional. You can build conditional expressions that use
condition
operators, such as equals or less than, to match the condition in the policy with
values in the request.
If you specify multiple Condition
elements in a statement, or multiple keys
in a single Condition
element, Amazon evaluates them using a logical
AND
operation. If you specify multiple values for a single condition key, Amazon
evaluates the condition using a logical OR
operation. All of the conditions must
be met before the statement's permissions are granted.
You can also use placeholder variables when you specify conditions. For example, you can grant a user permission to access a resource only if it is tagged with their user name. For more information, see IAM policy elements: Variables and tags in the IAM User Guide.
Amazon IoT Analytics does not provide any sevice-specific condition keys, but it does support using some global condition keys. To see all Amazon global condition keys, see Amazon global condition context keys. in the IAM User Guide.
Examples
To view examples of Amazon IoT Analytics identity-based policies, see Amazon IoT Analytics identity-based policy examples.
Amazon IoT Analytics resource-based policies
Amazon IoT Analytics does not support resource-based policies. To view an example of a detailed resource-based policy page, see Using resource-based policies for Amazon Lambda in the Amazon Lambda Developer Guide.
Authorization based on Amazon IoT Analytics tags
You can attach tags to Amazon IoT Analytics resources or pass tags in a request to Amazon IoT Analytics. To control
access based on tags, your provide tag information in the condition element of a
policy using the iotanalytics:ResourceTag/{key-name}, aws:RequestTag/{key-name}
or
aws:TagKeys
condition keys. For more information about tagging Amazon IoT Analytics resources,
see Tagging your Amazon IoT Analytics
resources.
To view an example identity-based policy for limiting access to a resource based on the tags on that resource, see Viewing Amazon IoT Analytics channels based on tags.
Amazon IoT Analytics IAM roles
An IAM role is an entity within your Amazon Web Services account that has specific permissions.
Using temporary credential with Amazon IoT Analytics
You can use temporary credentials to sign in with federation, assume an IAM role, or to assume a cross-account role. You obtain temporary security credentials by calling Amazon Security Token Service (Amazon STS) API operations such as AssumeRole or GetFederationToken.
Amazon IoT Analytics does not support using temporary credentials.
Service-linked roles
Service-lined roles allow Amazon service to access resources in other services to complete an action on your behalf. Service-linked roles appear in your IAM account and are owned by the service. An IAM administrator can view but not edit the permissions for service-linked roles.
Amazon IoT Analytics does not support service-linked roles.
Service roles
This feature allows a service to assume a service role on your behalf. This role allows the service to access resources in other services to complete an action on your behalf. Service roles appear in your IAM account and are owned by the account. This means that an IAM administrator can change the permissions for this role. However, doing so might break the functionality of the service.
Amazon IoT Analytics supports service roles.