Modify the specified AWS role object using the provided parameters. 

NOTE: APIs for AWS roles apply only to instances of the that are hosted on AWS and configured for user mode of authentication.

For more information on how to use awsRole objects, see API Workflow - Manage AWS Configurations.


Version:  v4

Required Permissions

Request

Request Type: PUT

Endpoint:

/v4/awsRoles/<id>

where:

ParameterDescription
<id>Internal identifier for the AWS roles object


Request URI - Example:

/v4/awsRoles/2

The request body contains the parameters of the awsRoles object that you wish to modify. You do not have to include parameters that are not being modified.

Request Body - IAM role ARN assignment:

The following changes the IAM role ARN for the AWS Role object.

NOTE: When an AWS role object has been created, it must be assigned to an AWS configuration object. This assignment cannot be modified after creation. You must delete the AWS role object and recreate it.


{
  "role", "<my_new_iam_role_arn>"
}

Response

Response Status Code - Success:  200 - OK

Response Body Example:

{
    "createdFrom": "api",
    "id": 2,
    "role": "<my_new_iam_role_arn>",
    "awsConfig": {
      "id": 1
    },
    "updatedAt": "2019-07-15T23:18:59.360Z",
    "createdAt": "2019-07-15T23:18:59.360Z",
    "deleted_at": null
}

Reference

For more information, see API AWSRoles Get v4.