Actions, resources, and condition keys for AWS IoT Greengrass V2

AWS IoT Greengrass V2 (service prefix: greengrass) provides the following service-specific resources, actions, and condition context 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.

Topics

Actions defined by AWS IoT Greengrass V2
Resource types defined by AWS IoT Greengrass V2
Condition keys for AWS IoT Greengrass V2

Actions defined by AWS IoT Greengrass V2

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 Access level column of the Actions table describes how the action is classified (List, Read, Permissions management, or Tagging). This classification can help you understand the level of access that an action grants when you use it in a policy. For more information about access levels, see Access levels in policy summaries.

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.

The Dependent actions column of the Actions table shows additional permissions that may be required to successfully call an action. These permissions may be needed in addition to the permission for the action itself. When an action specifies dependent actions, those dependencies may apply to additional resources defined for that action, not only the first resource listed in the 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
AssociateServiceRoleToAccount	Grants permission to associate a role with your account. AWS IoT Greengrass uses this role to access your Lambda functions and AWS IoT resources	Permissions management			iam:PassRole
BatchAssociateClientDeviceWithCoreDevice	Grants permission to associate a list of client devices with a core device	Write	coreDevice*
BatchDisassociateClientDeviceFromCoreDevice	Grants permission to disassociate a list of client devices from a core device	Write	coreDevice*
CancelDeployment	Grants permission to cancel a deployment	Write	deployment*		iot:CancelJob iot:DeleteThingShadow iot:DescribeJob iot:DescribeThing iot:DescribeThingGroup iot:GetThingShadow iot:UpdateJob iot:UpdateThingShadow
CreateComponentVersion	Grants permission to create a component	Write	component*
CreateComponentVersion	Grants permission to create a component	Write		aws:RequestTag/${TagKey} aws:TagKeys
CreateDeployment	Grants permission to create a deployment	Write		aws:RequestTag/${TagKey} aws:TagKeys	iot:CancelJob iot:CreateJob iot:DeleteThingShadow iot:DescribeJob iot:DescribeThing iot:DescribeThingGroup iot:GetThingShadow iot:UpdateJob iot:UpdateThingShadow
DeleteComponent	Grants permission to delete a component	Write	componentVersion*
DeleteCoreDevice	Grants permission to delete a AWS IoT Greengrass core device, which is an AWS IoT thing. This operation removes the core device from the list of core devices. This operation doesn't delete the AWS IoT thing	Write	coreDevice*		iot:DescribeJobExecution
DeleteDeployment	Grants permission to delete a deployment. To delete an active deployment, it needs to be cancelled first	Write	deployment*		iot:DeleteJob
DescribeComponent	Grants permission to retrieve metadata for a version of a component	Read	componentVersion*
DisassociateServiceRoleFromAccount	Grants permission to disassociate the service role from an account. Without a service role, deployments will not work	Write
GetComponent	Grants permission to get the recipe for a version of a component	Read	componentVersion*
GetComponentVersionArtifact	Grants permission to get the pre-signed URL to download a public component artifact	Read	componentVersion*
GetConnectivityInfo	Grants permission to retrieve the connectivity information for a Greengrass core device	Read	connectivityInfo*		iot:GetThingShadow
GetCoreDevice	Grants permission to retrieves metadata for a AWS IoT Greengrass core device	Read	coreDevice*
GetDeployment	Grants permission to get a deployment	Read	deployment*		iot:DescribeJob iot:DescribeThing iot:DescribeThingGroup iot:GetThingShadow
GetServiceRoleForAccount	Grants permission to retrieve the service role that is attached to an account	Read
ListClientDevicesAssociatedWithCoreDevice	Grants permission to retrieve a paginated list of client devices associated to a AWS IoT Greengrass core device	List	coreDevice*
ListComponentVersions	Grants permission to retrieve a paginated list of all versions for a component	List	component*
ListComponents	Grants permission to retrieve a paginated list of component summaries	List
ListCoreDevices	Grants permission to retrieve a paginated list of AWS IoT Greengrass core devices	List
ListDeployments	Grants permission to retrieves a paginated list of deployments	List			iot:DescribeJob iot:DescribeThing iot:DescribeThingGroup iot:GetThingShadow
ListEffectiveDeployments	Grants permission to retrieves a paginated list of deployment jobs that AWS IoT Greengrass sends to AWS IoT Greengrass core devices	List	coreDevice*		iot:DescribeJob iot:DescribeJobExecution iot:DescribeThing iot:DescribeThingGroup iot:GetThingShadow
ListInstalledComponents	Grants permission to retrieve a paginated list of the components that a AWS IoT Greengrass core device runs	List	coreDevice*
ListTagsForResource	Grants permission to list the tags for a resource	Read	component
			componentVersion
			coreDevice
			deployment
				aws:RequestTag/${TagKey} aws:TagKeys
ResolveComponentCandidates	Grants permission to list components that meet the component, version, and platform requirements of a deployment	List	componentVersion*
TagResource	Grants permission to add tags to a resource	Tagging	component
			componentVersion
			coreDevice
			deployment
				aws:RequestTag/${TagKey} aws:TagKeys
UntagResource	Grants permission to remove tags from a resource	Tagging	component
			componentVersion
			coreDevice
			deployment
				aws:RequestTag/${TagKey} aws:TagKeys
UpdateConnectivityInfo	Grants permission to update the connectivity information for a Greengrass core. Any devices that belong to the group that has this core will receive this information in order to find the location of the core and connect to it	Write	connectivityInfo*		iot:GetThingShadow iot:UpdateThingShadow

Resource types defined by AWS IoT Greengrass V2

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
connectivityInfo	`arn:${Partition}:greengrass:${Region}:${Account}:/greengrass/things/${ThingName}/connectivityInfo`
component	`arn:${Partition}:greengrass:${Region}:${Account}:components:${ComponentName}`	aws:ResourceTag/${TagKey}
componentVersion	`arn:${Partition}:greengrass:${Region}:${Account}:components:${ComponentName}:versions:${ComponentVersion}`	aws:ResourceTag/${TagKey}
coreDevice	`arn:${Partition}:greengrass:${Region}:${Account}:coreDevices:${CoreDeviceThingName}`	aws:ResourceTag/${TagKey}
deployment	`arn:${Partition}:greengrass:${Region}:${Account}:deployments:${DeploymentId}`	aws:ResourceTag/${TagKey}

Condition keys for AWS IoT Greengrass V2

AWS IoT Greengrass V2 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 AWS global condition context keys.

Condition keys	Description	Type
aws:RequestTag/${TagKey}	Filters access by checking tag key/value pairs included in the request	String
aws:ResourceTag/${TagKey}	Filters access by checking tag key/value pairs associated with a specific resource	String
aws:TagKeys	Filters access by checking tag keys passed in the request	ArrayOfString

Warning 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.

Document Conventions

AWS IoT Greengrass

AWS IoT Jobs DataPlane