This is an archive version of the document. To get the most up-to-date information, see the current version.

Schemas

The following JSON schemas are used to represent resources in the /accounts/amazon collection in the Veeam Backup for AWS REST API. Properties included in schemas represent IAM role details. Some of the properties can be used as parameters in POST and PUT requests as well as for query parameter values in GET requests

Schemas AmazonAccount

Property	Type	Description
id	string	System ID assigned to an IAM role in the Veeam Backup for AWS REST API.
name	string	Name of the IAM role in Veeam Backup for AWS.
description	string	Description of the IAM role.
awsid	string	AWS ID of an AWS account in which the IAM role was created.
regionType	string	Region type of the AWS account (Global, Emulator, Government, China).
accessKeys	AmazonAccountAccessKeys	[Applies only if the role was added using the Create a new IAM Role mode] IAM role details.
IAMRole	AmazonAccountIAMRole	[Applies only if the role was added using the IAM Role from current account mode] IAM role details.
IAMRoleFromAnotherAccount	AmazonAccountIAMRoleFromAnotherAccount	[Applies only if the role was added using the IAM Role from another account mode] IAM role details.
_links	array	A list of methods and operations available for the IAM role in the Veeam Backup for AWS REST API, and request URLs used to perform the operations.

AmazonAccountAccessKeys

Property	Type	Description
accessKey	string	An access key generated by AWS for an AWS account.
defaultRegion	string	Default region type of the AWS account (Global, Emulator, Government, China).

AmazonAccountIAMRole

Property	Type	Description
parentAmazonAccountId	string	System ID assigned to the initial AWS account in the Veeam Backup for AWS REST API.
roleName	string	IAM role name in AWS.
isDefault	boolean	Defines whether the IAM role is the Default Backup Restore IAM role.

AmazonAccountIAMRoleFromAnotherAccount

Property	Type	Description
parentAmazonAccountId	string	System ID assigned to the initial (trusted) AWS account in the Veeam Backup for AWS REST API.
accountId	string	AWS ID of a trusting AWS account.
roleName	boolean	Cross-account IAM role name in AWS.