AWS Greengrass
API Reference

GetAssociatedRole

Retrieves the role associated with a particular group.

URI: GET /greengrass/groups/GroupId/role

CLI:

aws greengrass get-associated-role \ --group-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "GroupId": "string" }

Parameters:

GroupId

The ID of the Greengrass group.

where used: path; required: true

type: string

Responses:

200

success

GetAssociatedRoleResponse

{ "AssociatedAt": "string", "RoleArn": "string" }
GetAssociatedRoleResponse

type: object

AssociatedAt

The time when the role was associated with the group.

type: string

RoleArn

The ARN of the role that is 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 containing 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 containing 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