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

Actions, resources, and condition keys for AWS IoT 1-Click

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

References:

Actions defined by AWS IoT 1-Click

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
AssociateDeviceWithPlacement Grants permission to associate a device to a placement Write

project*

ClaimDevicesByClaimCode Grants permission to claim a batch of devices with a claim code Read
CreatePlacement Grants permission to create a new placement in a project Write

project*

CreateProject Grants permission to create a new project Write

project*

aws:RequestTag/${TagKey}

aws:TagKeys

DeletePlacement Grants permission to delete a placement from a project Write

project*

DeleteProject Grants permission to delete a project Write

project*

DescribeDevice Grants permission to describe a device Read

device*

DescribePlacement Grants permission to describe a placement Read

project*

DescribeProject Grants permission to describe a project Read

project*

DisassociateDeviceFromPlacement Grants permission to disassociate a device from a placement Write

project*

FinalizeDeviceClaim Grants permission to finalize a device claim Read

device*

aws:RequestTag/${TagKey}

aws:TagKeys

GetDeviceMethods Grants permission to get available methods of a device Read

device*

GetDevicesInPlacement Grants permission to get devices associated to a placement Read

project*

InitiateDeviceClaim Grants permission to initialize a device claim Read

device*

InvokeDeviceMethod Grants permission to invoke a device method Write

device*

ListDeviceEvents Grants permission to list past events published by a device Read

device*

ListDevices Grants permission to list all devices List
ListPlacements Grants permission to list placements in a project Read

project*

ListProjects Grants permission to list all projects List
ListTagsForResource Grants permission to lists the tags for a resource Read

device

project

TagResource Grants permission to add or modify the tags of a resource Tagging

device

project

aws:RequestTag/${TagKey}

aws:TagKeys

UnclaimDevice Grants permission to unclaim a device Read

device*

UntagResource Grants permission to remove the given tags (metadata) from a resource Tagging

device

project

aws:TagKeys

UpdateDeviceState Grants permission to update device state Write

device*

UpdatePlacement Grants permission to update a placement Write

project*

UpdateProject Update a project Write

project*

Resource types defined by AWS IoT 1-Click

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
device arn:${Partition}:iot1click:${Region}:${Account}:devices/${DeviceId}

aws:ResourceTag/${TagKey}

project arn:${Partition}:iot1click:${Region}:${Account}:projects/${ProjectName}

aws:ResourceTag/${TagKey}

Condition keys for AWS IoT 1-Click

AWS IoT 1-Click 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 actions based on the tags that are passed in the request String
aws:ResourceTag/${TagKey} Filters actions based on the tags associated with the resource String
aws:TagKeys Filters actions based on the tag keys that are passed in the request ArrayOfString