This is an archive version of the document. To get the most up-to-date information, see the current version.Modify IAM Role
You can update an IAM role with the specified ID in the Veeam Backup for AWS configuration database.
Request
To change data for a specific IAM role, send the HTTP PUT request to the /accounts/amazon/{amazonAccountId} endpoint. {amazonAccountId} is a system ID assigned to the IAM role in the Veeam Backup for AWS REST API.
HTTP Request
PUT https://<hostname>:<port>/api/v1/accounts/amazon/{amazonAccountId} |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
|---|---|---|---|
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
x-api-version | Required | 1.0-rev0 | Specifies the current revision of the Veeam Backup for AWS REST API. |
Content-Type | Required | application/json | Identifies a media type that is used in the body of the request. |
Accept | Optional |
| Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request Body
To specify data to be changed for the IAM role, send the following parameters in the request body.
Parameter | Required/Optional | Type | Description |
|---|---|---|---|
name | Required | string | Specifies an IAM role name in Veeam Backup for AWS. |
description | Optional | string | Specifies a n IAM role description. Note: If you do not send the description parameter in the request body, the value is set to null by default. |
accessKeys | Optional | [Applies only if the role was added using the Create a new IAM Role mode] Specifies new parameters for the IAM role. | |
IAMRole | Optional | [Applies only if the role was added using the IAM Role from current account mode] Specifies new parameters for the IAM role. | |
IAMRoleFromAnotherAccount | Optional | [Applies only if the role was added using the IAM Role from another account mode] Specifies new parameters for the IAM role. |
Note |
Before you update an IAM role, you can check whether a name you plan to specify as an IAM role name in Veeam Backup for AWS is unique. For more information, see Validate IAM Role Name. |
AmazonAccountAccessKeyUpdateSpec
AmazonAccountIAMRoleUpdateSpec
AmazonAccountIAMRoleFromAnotherAccountUpdateSpec
Set the parameter values in the following format:
{ "name": "string", "description": "string", "accessKeys": { "accessKey": "string", "secretKey": "string", "defaultRegionType": "Global" }, "IAMRole": { "roleName": "string" }, "IAMRoleFromAnotherAccount": { "accountId": "string", "roleName": "string", "externalId": "string" } } |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns a response code 200 (OK).
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Value | Description |
|---|---|---|
Content-Length | integer | Identifies the length of the response body message, in bytes. |
Content-Type |
| Identifies the media type of the response body message. |
Response Body
In the response body, Veeam Backup for AWS returns an updated representation of the IAM role. The AmazonAccount schema is used for the resource representation.
Example
The following request modifies the name and description of an IAM role with the ID aa8bb04c-1e70-4ddf-9e35-7149e4920d1e.
|