PUT

/greengrass/groups/{GroupId}/role

http://greengrass.{region}.amazonaws.com/greengrass/groups/{GroupId}/role

Associates a role with a group. Your Greengrass core will use the role to access AWS cloud services. The role's permissions should allow Greengrass core Lambda functions to perform actions against the cloud.

Access Token Required: API Key

Path Parameters

GroupIdstringrequired

The ID of the Greengrass group.

Body Params

RoleArnstringrequired

The ARN of the role you wish to associate with this group. The existence of the role is not validated.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://greengrass.{region}.amazonaws.com/greengrass/groups/{GroupId}/role' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}