AssociateRoleToGroup - AWS IoT Greengrass
CLI: Parameters: Responses:

You are viewing the documentation for AWS IoT Greengrass Version 1. AWS IoT Greengrass Version 2 is the latest major version of AWS IoT Greengrass. For more information about the AWS IoT Greengrass Version 2 API, see the AWS IoT Greengrass V2 API Reference.

AssociateRoleToGroup

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

URI: PUT /greengrass/groups/GroupId/role

CLI:

aws greengrass associate-role-to-group \
  --group-id <value> \
  [--role-arn <value>]  \
  [--cli-input-json <value>] \
  [--generate-cli-skeleton]

cli-input-json format:

{
"GroupId": "string",
"RoleArn": "string"
}

Parameters:

GroupId

The ID of the Greengrass group.

where used: path; required: true

type: string

AssociateRoleToGroupRequestBody

where used: body; required: true

{
"RoleArn": "string"
}

schema:

AssociateRoleToGroupRequest

type: object

required: ["RoleArn"]

RoleArn

The ARN of the role to associate with this group.

type: string

Responses:

200

Success.

AssociateRoleToGroupResponse 

{
"AssociatedAt": "string"
}
Group

type: object

AssociatedAt

The time, in milliseconds since the epoch, when the role ARN was associated with the group.

type: string

400

Invalid request.

GeneralError 

{
"Message": "string",
"ErrorDetails": [
  {
    "DetailedErrorCode": "string",
    "DetailedErrorMessage": "string"
  }
]
}
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message that contains information about the error.

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string

500

Server error.

GeneralError 

{
"Message": "string",
"ErrorDetails": [
  {
    "DetailedErrorCode": "string",
    "DetailedErrorMessage": "string"
  }
]
}
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message that contains information about the error.

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string