This is an archive version of the document. To get the most up-to-date information, see the current version.Change IAM Role Used to Launch Worker Instances
You can change an IAM role used by Veeam Backup for AWS to launch worker instances.
Note |
If you change the IAM role used to launch worker instances, all configured network settings for AWS regions where Veeam Backup for AWS launches worker instances will be lost. |
Request
To change an IAM role, send the HTTP PUT request to the /settings/serviceAccount endpoint.
HTTP Request
PUT https://<hostname>:<port>/api/v1/settings/serviceAccount |
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 change the IAM role, send the following parameter in the request body.
Parameter | Type | Description |
|---|---|---|
serviceAmazonAccountId | string($uuid) | Specifies the system ID of the IAM role that will be used to launch worker instances. |
Set the parameter value in the following format:
{ "serviceAmazonAccountId": "string($uuid)" } |
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 a representation of the IAM role that will be used by Veeam Backup for AWS to launch worker instances from this moment. The ServiceAccountSettings schema is used for the representation.
Example
The following request configures the IAM role with the ID 3fa85f64-5717-4562-b3fc-2c963f66afa6 to launch worker instances.
|