End of support notice: On October 7th, 2026, Amazon will discontinue support for Amazon IoT Greengrass Version 1. After October 7th, 2026, you will no longer be able to access the Amazon IoT Greengrass V1 resources. For more information, please visit [Migrate from Amazon IoT Greengrass Version 1](https://docs.amazonaws.cn/greengrass/v2/developerguide/migrate-from-v1.html). # Greengrass service role The Greengrass service role is an Amazon Identity and Access Management (IAM) service role that authorizes Amazon IoT Greengrass to access resources from Amazon services on your behalf. This makes it possible for Amazon IoT Greengrass to perform essential tasks, such as retrieving your Amazon Lambda functions and managing Amazon IoT shadows. To allow Amazon IoT Greengrass to access your resources, the Greengrass service role must be associated with your Amazon Web Services account and specify Amazon IoT Greengrass as a trusted entity. The role must include the [ AWSGreengrassResourceAccessRolePolicy](https://console.amazonaws.cn/iam/home#/policies/arn:aws:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy) managed policy or a custom policy that defines equivalent permissions for the Amazon IoT Greengrass features that you use. This policy is maintained by Amazon and defines the set of permissions that Amazon IoT Greengrass uses to access your Amazon resources. You can reuse the same Greengrass service role across Amazon Web Services Regions, but you must associate it with your account in every Amazon Web Services Region where you use Amazon IoT Greengrass. Group deployment fails if the service role doesn't exist in the current Amazon Web Services account and Region. The following sections describe how to create and manage the Greengrass service role in the Amazon Web Services Management Console or Amazon CLI. + [Manage the service role (console)](#manage-service-role-console) + [Manage the service role (CLI)](#manage-service-role-cli) **Note** In addition to the service role that authorizes service-level access, you can assign a *group role* to an Amazon IoT Greengrass group. The group role is a separate IAM role that controls how Greengrass Lambda functions and connectors in the group can access Amazon services. ## Managing the Greengrass service role (console) The Amazon IoT console makes it easy to manage your Greengrass service role. For example, when you create or deploy a Greengrass group, the console checks whether your Amazon Web Services account is attached to a Greengrass service role in the Amazon Web Services Region that's currently selected in the console. If not, the console can create and configure a service role for you. For more information, see [Create the Greengrass service role (console)](#create-service-role-console). You can use the Amazon IoT console for the following role management tasks: + [Find your Greengrass service role](#get-service-role-console) + [Create the Greengrass service role](#create-service-role-console) + [Change the Greengrass service role](#update-service-role-console) + [Detach the Greengrass service role](#remove-service-role-console) **Note** The user who is signed in to the console must have permissions to view, create, or change the service role.   ### Find your Greengrass service role (console) Use the following steps to find the service role that Amazon IoT Greengrass is using in the current Amazon Web Services Region. 1. From the [Amazon IoT console](https://console.amazonaws.cn/iot/) navigation pane, choose **Settings**. 1. Scroll to the **Greengrass service role** section to see your service role and its policies. If you don't see a service role, you can let the console create or configure one for you. For more information, see [Create the Greengrass service role](#create-service-role-console).   ### Create the Greengrass service role (console) The console can create and configure a default Greengrass service role for you. This role has the following properties. | Property | Value | | --- | --- | | Name | Greengrass\_ServiceRole | | Trusted entity | AWS service: greengrass | | Policy | [ AWSGreengrassResourceAccessRolePolicy](https://console.amazonaws.cn/iam/home#/policies/arn:aws:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy) | **Note** If [Greengrass device setup](quick-start.md) creates the service role, the role name is `GreengrassServiceRole_{{random-string}}`. When you create or deploy a Greengrass group from the Amazon IoT console, the console checks whether a Greengrass service role is associated with your Amazon Web Services account in the Amazon Web Services Region that's currently selected in the console. If not, the console prompts you to allow Amazon IoT Greengrass to read and write to Amazon services on your behalf. If you grant permission, the console checks whether a role named `Greengrass_ServiceRole` exists in your Amazon Web Services account. + If the role exists, the console attaches the service role to your Amazon Web Services account in the current Amazon Web Services Region. + If the role doesn't exist, the console creates a default Greengrass service role and attaches it to your Amazon Web Services account in the current Amazon Web Services Region. **Note** If you want to create a service role with custom role policies, use the IAM console to create or modify the role. For more information, see [Creating a role to delegate permissions to an Amazon service](https://docs.amazonaws.cn/IAM/latest/UserGuide/id_roles_create_for-service.html) or [Modifying a role](https://docs.amazonaws.cn/IAM/latest/UserGuide/id_roles_manage_modify.html) in the *IAM User Guide*. Make sure that the role grants permissions that are equivalent to the `AWSGreengrassResourceAccessRolePolicy` managed policy for the features and resources that you use. We recommend that you also include the `aws:SourceArn` and `aws:SourceAccount` global condition context keys in your trust policy to help prevent the *confused deputy* security problem. The condition context keys restrict access to allow only those requests that come from the specified account and Greengrass workspace. For more information about the confused deputy problem, see [Cross-service confused deputy prevention](cross-service-confused-deputy-prevention.md). If you create a service role, return to the Amazon IoT console and attach the role to the group. You can do this under **Greengrass service role** on the group's **Settings** page.   ### Change the Greengrass service role (console) Use the following procedure to choose a different Greengrass service role to attach to your Amazon Web Services account in the Amazon Web Services Region currently selected in the console. 1. From the [Amazon IoT console](https://console.amazonaws.cn/iot/) navigation pane, choose **Settings**. 1. Under **Greengrass service role**, choose **Change role**. The **Update Greengrass service role** dialog box opens and shows the IAM roles in your Amazon Web Services account that define Amazon IoT Greengrass as a trusted entity. 1. Choose the Greengrass service role to attach. 1. Choose **Attach role**. **Note** To allow the console to create a default Greengrass service role for you, choose **Create role for me** instead of choosing a role from the list. The **Create role for me** link does not appear if a role named `Greengrass_ServiceRole` is in your Amazon Web Services account.   ### Detach the Greengrass service role (console) Use the following procedure to detach the Greengrass service role from your Amazon Web Services account in the Amazon Web Services Region currently selected in the console. This revokes permissions for Amazon IoT Greengrass to access Amazon services in the current Amazon Web Services Region. **Important** Detaching the service role might interrupt active operations. 1. From the [Amazon IoT console](https://console.amazonaws.cn/iot/) navigation pane, choose **Settings**. 1. Under **Greengrass service role**, choose **Detach role**. 1. In the confirmation dialog box, choose **Detach**. **Note** If you no longer need the role, you can delete it in the IAM console. For more information, see [Deleting roles or instance profiles](https://docs.amazonaws.cn/IAM/latest/UserGuide/id_roles_manage_delete.html) in the *IAM User Guide*. Other roles might allow Amazon IoT Greengrass to access your resources. To find all roles that allow Amazon IoT Greengrass to assume permissions on your behalf, in the IAM console, on the **Roles** page, look for roles that include **Amazon service: greengrass** in the **Trusted entities** column. ## Managing the Greengrass service role (CLI) In the following procedures, we assume that the Amazon CLI is installed and configured to use your Amazon Web Services account ID. For more information, see [Installing the Amazon command line interface](https://docs.amazonaws.cn/cli/latest/userguide/installing.html) and [Configuring the Amazon CLI](https://docs.amazonaws.cn/cli/latest/userguide/cli-chap-getting-started.html) in the *Amazon Command Line Interface User Guide*. You can use the Amazon CLI for the following role management tasks: + [Get your Greengrass service role](#get-service-role) + [Create the Greengrass service role](#create-service-role) + [Remove the Greengrass service role](#remove-service-role)   ### Get the Greengrass service role (CLI) Use the following procedure to find out if a Greengrass service role is associated with your Amazon Web Services account in an Amazon Web Services Region. + Get the service role. Replace {{region}} with your Amazon Web Services Region (for example, `us-west-2`). ``` aws Greengrass get-service-role-for-account --region {{region}} ``` If a Greengrass service role is already associated with your account, the following role metadata is returned. ``` { "AssociatedAt": "{{timestamp}}", "RoleArn": "arn:aws-cn:iam::{{account-id}}:role/{{path/role-name}}" } ``` If no role metadata is returned, then you must create the service role (if it doesn't exist) and associate it with your account in the Amazon Web Services Region.   ### Create the Greengrass service role (CLI) Use the following steps to create a role and associate it with your Amazon Web Services account. **To create the service role using IAM** 1. Create the role with a trust policy that allows Amazon IoT Greengrass to assume the role. This example creates a role named `Greengrass_ServiceRole`, but you can use a different name. We recommend that you also include the `aws:SourceArn` and `aws:SourceAccount` global condition context keys in your trust policy to help prevent the *confused deputy* security problem. The condition context keys restrict access to allow only those requests that come from the specified account and Greengrass workspace. For more information about the confused deputy problem, see [Cross-service confused deputy prevention](cross-service-confused-deputy-prevention.md). ------ #### [ Linux, macOS, or Unix ] ``` aws iam create-role --role-name Greengrass_ServiceRole --assume-role-policy-document '{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "greengrass.amazonaws.com" }, "Action": "sts:AssumeRole", "Condition": { "StringEquals": { "aws:SourceAccount": "{{account-id}}" }, "ArnLike": { "aws:SourceArn": "arn:aws-cn:greengrass:{{region}}:{{account-id}}:*" } } } ] }' ``` ------ #### [ Windows command prompt ] ``` aws iam create-role --role-name Greengrass_ServiceRole --assume-role-policy-document "{\"Version\":\"2012-10-17\", \"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"Service\":\"greengrass.amazonaws.com\"},\"Action\":\"sts:AssumeRole\",\"Condition\":{\"ArnLike\":{\"aws:SourceArn\":\"arn:aws-cn:greengrass:{{region}}:{{account-id}}:*\"},\"StringEquals\":{\"aws:SourceAccount\":\"{{account-id}}\"}}}]}" ``` ------ 1. Copy the role ARN from the role metadata in the output. You use the ARN to associate the role with your account. 1. Attach the `AWSGreengrassResourceAccessRolePolicy` policy to the role. ``` aws iam attach-role-policy --role-name Greengrass_ServiceRole --policy-arn arn:aws-cn:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy ``` **To associate the service role with your Amazon Web Services account** + Associate the role with your account. Replace {{role-arn}} with the service role ARN and {{region}} with your Amazon Web Services Region (for example, `us-west-2`). ``` aws greengrass associate-service-role-to-account --role-arn {{role-arn}} --region {{region}} ``` If successful, the following response is returned. ``` { "AssociatedAt": "{{timestamp}}" } ```   ### Remove the Greengrass service role (CLI) Use the following steps to disassociate the Greengrass service role from your Amazon Web Services account. + Disassociate the service role from your account. Replace {{region}} with your Amazon Web Services Region (for example, `us-west-2`). ``` aws greengrass disassociate-service-role-from-account --region {{region}} ``` If successful, the following response is returned. ``` { "DisassociatedAt": "{{timestamp}}" } ``` **Note** You should delete the service role if you're not using it in any Amazon Web Services Region. First use [https://docs.amazonaws.cn/cli/latest/reference/iam/delete-role-policy.html](https://docs.amazonaws.cn/cli/latest/reference/iam/delete-role-policy.html) to detach the `AWSGreengrassResourceAccessRolePolicy` managed policy from the role, and then use [https://docs.amazonaws.cn/cli/latest/reference/iam/delete-role.html](https://docs.amazonaws.cn/cli/latest/reference/iam/delete-role.html) to delete the role. For more information, see [Deleting roles or instance profiles](https://docs.amazonaws.cn/IAM/latest/UserGuide/id_roles_manage_delete.html) in the *IAM User Guide*. ## See also + [Creating a role to delegate permissions to an Amazon service](https://docs.amazonaws.cn/IAM/latest/UserGuide/id_roles_create_for-service.html) in the *IAM User Guide* + [Modifying a role](https://docs.amazonaws.cn/IAM/latest/UserGuide/id_roles_manage_modify.html) in the *IAM User Guide* + [Deleting roles or instance profiles](https://docs.amazonaws.cn/IAM/latest/UserGuide/id_roles_manage_delete.html) in the *IAM User Guide* + Amazon IoT Greengrass commands in the *Amazon CLI Command Reference* + [associate-service-role-to-account](https://docs.amazonaws.cn/cli/latest/reference/greengrass/associate-service-role-to-account.html) + [disassociate-service-role-from-account](https://docs.amazonaws.cn/cli/latest/reference/greengrass/disassociate-service-role-from-account.html) + [get-service-role-for-account](https://docs.amazonaws.cn/cli/latest/reference/greengrass/get-service-role-for-account.html) + IAM commands in the *Amazon CLI Command Reference* + [attach-role-policy](https://docs.amazonaws.cn/cli/latest/reference/iam/attach-role-policy.html) + [create-role](https://docs.amazonaws.cn/cli/latest/reference/iam/create-role.html) + [delete-role](https://docs.amazonaws.cn/cli/latest/reference/iam/delete-role.html) + [delete-role-policy](https://docs.amazonaws.cn/cli/latest/reference/iam/delete-role-policy.html)