AssociateServiceRoleToAccount - Amazon IoT Greengrass
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

AssociateServiceRoleToAccount

Associates a Greengrass service role with Amazon IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region. Amazon 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 Amazon IoT Greengrass features that you use. For more information, see Greengrass service role in the Amazon 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 Amazon IoT Greengrass for your Amazon Web Services account in this Amazon Web Services 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 Amazon IoT Greengrass for your Amazon Web Services account in this Amazon Web Services Region.

Type: String

Errors

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

InternalServerException

Amazon 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

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: