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 /amazonConnections collection in the Veeam Backup for AWS REST API. Properties included in schemas can be used in POST requests as well as for query parameter values in GET requests.

Schemas AmazonConnection

Property	Type	Description
id	string	System ID assigned to an amazon connection in the Veeam Backup for AWS REST API.
_links	array	A list of methods and operations available for the amazon connection in the Veeam Backup for AWS REST API, and request URLs used to perform the operations.

Schemas CloudNetwork

Property	Type	Description
resourceId	string	AWS ID of an Amazon VPC (a virtual private cloud dedicated to an AWS account).
name	string	AWS name of the Amazon VPC.
cidrBlock	string	IPv4 CIDR block.
state	string	VPC state: Available, Pending.
isDefault	boolean	Defines whether the Amazon VPC is the default virtual private cloud for the AWS region.

Schemas CloudSubnetwork

Property	Type	Description
resourceId	string	AWS ID of a subnet (a range of IP addresses in your VPC).
name	string	AWS name of the subnet.
cloudNetworkResourceId	string	AWS ID of the Amazon VPC that the subnet belongs to.
cidrBlock	string	IPv4 CIDR block.
availabilityZone	string	Availability zone

Schemas CloudSecurityGroup

Property	Type	Description
resourceId	string	AWS ID of a security group.
cloudNetworkResourceId	string	AWS ID of the Amazon VPC that the security group belongs to.
name	string	AWS name of the security group.

Schemas Region

Property	Type	Description
id	string($uuid)	System ID assigned to an AWS region or Availability Zone in the Veeam Backup for AWS REST API.
name	string	Name of the AWS region or Availability Zone.
_links	array	A list of methods and operations available for the AWS region or Availability Zone in the Veeam Backup for AWS REST API, and request URLs used to perform the operations.

Schemas CloudEncryptionKey

Property	Type	Description
arn	string	Amazon Resource Name (key ARN).
name	string	Name of the key.

Schemas BucketFolder

Property	Type	Description
name	string	Name of a folder in an Amazon S3 bucket with the specified ID.
folderId	string($uuid)	System ID assigned to the folder in the Veeam Backup for AWS REST API.