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.
AssociateServiceRoleToAccount
Associates a role with your account. AWS IoT Greengrass uses the role to access your
Lambda functions and AWS IoT resources. A role is required for deployments to succeed.
The
role must have at least minimum permissions in the policy
AWSGreengrassResourceAccessRolePolicy
.
URI: PUT /greengrass/servicerole
CLI:
aws greengrass associate-service-role-to-account \ [--role-arn <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "RoleArn": "string" }
Parameters:
- AssociateServiceRoleToAccountRequestBody
-
where used: body; required: true
{ "RoleArn": "string" }
schema:
- AssociateServiceRoleToAccountRequest
-
type: object
required: ["RoleArn"]
- RoleArn
-
The ARN of the service role to associate with your account.
type: string
Responses:
- 200
-
Success.
AssociateServiceRoleToAccountResponse
{ "AssociatedAt": "string" }
- AssociateServiceRoleToAccountResponse
-
type: object
- AssociatedAt
-
The time when the service role was associated with the account.
type: string
- 400
-
Invalid request.
{ "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.
{ "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