Actions, resources, and condition keys for AWS IoT Analytics - Service Authorization Reference
ActionsResource typesCondition keys

Actions, resources, and condition keys for AWS IoT Analytics

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

References:

Actions defined by AWS IoT Analytics

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
BatchPutMessage Puts a batch of messages into the specified channel Write

channel*

CancelPipelineReprocessing Cancels reprocessing for the specified pipeline Write

pipeline*

CreateChannel Creates a channel Write

channel*

aws:RequestTag/${TagKey}

aws:TagKeys

CreateDataset Creates a dataset Write

dataset*

aws:RequestTag/${TagKey}

aws:TagKeys

CreateDatasetContent Generates content from the specified dataset (by executing the dataset actions) Write

dataset*

CreateDatastore Creates a datastore Write

datastore*

aws:RequestTag/${TagKey}

aws:TagKeys

CreatePipeline Creates a pipeline Write

pipeline*

aws:RequestTag/${TagKey}

aws:TagKeys

DeleteChannel Deletes the specified channel Write

channel*

DeleteDataset Deletes the specified dataset Write

dataset*

DeleteDatasetContent Deletes the content of the specified dataset Write

dataset*

DeleteDatastore Deletes the specified datastore Write

datastore*

DeletePipeline Deletes the specified pipeline Write

pipeline*

DescribeChannel Describes the specified channel Read

channel*

DescribeDataset Describes the specified dataset Read

dataset*

DescribeDatastore Describes the specified datastore Read

datastore*

DescribeLoggingOptions Describes logging options for the the account Read
DescribePipeline Describes the specified pipeline Read

pipeline*

GetDatasetContent Gets the content of the specified dataset Read

dataset*

ListChannels Lists the channels for the account List
ListDatasetContents Lists information about dataset contents that have been created List

dataset*

ListDatasets Lists the datasets for the account List
ListDatastores Lists the datastores for the account List
ListPipelines Lists the pipelines for the account List
ListTagsForResource Lists the tags (metadata) which you have assigned to the resource Read

channel

dataset

datastore

pipeline

PutLoggingOptions Puts logging options for the the account Write
RunPipelineActivity Runs the specified pipeline activity Read
SampleChannelData Samples the specified channel's data Read

channel*

StartPipelineReprocessing Starts reprocessing for the specified pipeline Write

pipeline*

TagResource Adds to or modifies the tags of the given resource. Tags are metadata which can be used to manage a resource Tagging

channel

dataset

datastore

pipeline

aws:RequestTag/${TagKey}

aws:TagKeys

UntagResource Removes the given tags (metadata) from the resource Tagging

channel

dataset

datastore

pipeline

aws:RequestTag/${TagKey}

aws:TagKeys

UpdateChannel Updates the specified channel Write

channel*

UpdateDataset Updates the specified dataset Write

dataset*

UpdateDatastore Updates the specified datastore Write

datastore*

UpdatePipeline Updates the specified pipeline Write

pipeline*

Resource types defined by AWS IoT Analytics

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
channel arn:${Partition}:iotanalytics:${Region}:${Account}:channel/${ChannelName}

aws:RequestTag/${TagKey}

aws:TagKeys

iotanalytics:ResourceTag/${TagKey}

dataset arn:${Partition}:iotanalytics:${Region}:${Account}:dataset/${DatasetName}

aws:RequestTag/${TagKey}

aws:TagKeys

iotanalytics:ResourceTag/${TagKey}

datastore arn:${Partition}:iotanalytics:${Region}:${Account}:datastore/${DatastoreName}

aws:RequestTag/${TagKey}

aws:TagKeys

iotanalytics:ResourceTag/${TagKey}

pipeline arn:${Partition}:iotanalytics:${Region}:${Account}:pipeline/${PipelineName}

aws:RequestTag/${TagKey}

aws:TagKeys

iotanalytics:ResourceTag/${TagKey}

Condition keys for AWS IoT Analytics

AWS IoT Analytics 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 based on the tags that are passed in the request String
aws:TagKeys Filters access based on the presence of tag keys in the request ArrayOfString
iotanalytics:ResourceTag/${TagKey} Filters access by the tag key-value pairs attached to the resource String