Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

AssociateServiceRoleToAccount

Associates a Greengrass service role with AWS IoT Greengrass for your AWS account in this AWS Region. AWS IoT Greengrass uses this role to verify the identity of client devices and manage core device connectivity information. The role must include the AWSGreengrassResourceAccessRolePolicy managed policy or a custom policy that defines equivalent permissions for the AWS IoT Greengrass features that you use. For more information, see Greengrass service role in the AWS IoT Greengrass Version 2 Developer Guide.

Request Syntax


PUT /greengrass/servicerole HTTP/1.1
Content-type: application/json

{
   "RoleArn": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

RoleArn

The Amazon Resource Name (ARN) of the service role to associate with AWS IoT Greengrass for your AWS account in this AWS Region.

Type: String

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "AssociatedAt": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

AssociatedAt

The time when the service role was associated with AWS IoT Greengrass for your AWS account in this AWS Region.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

AWS IoT Greengrass can't process your request right now. Try again later.

HTTP Status Code: 500

ValidationException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

HTTP Status Code: 400