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

Get-VBRAmazonAccount

Short Description

Returns AWS credentials records.

Applies to

Platform: VMware, Hyper-V

Product Edition: Community, Standard, Enterprise, Enterprise Plus, Veeam Universal License

Syntax

This cmdlet provides the following parameter sets:

To get AWS credentials records by the AWS access key.

Get-VBRAmazonAccount [-AccessKey <string[]>] [<CommonParameters>]

To get AWS credentials records by the AWS ID.

Get-VBRAmazonAccount -Id <guid[]> [<CommonParameters>]

Detailed Description

This cmdlet returns an array of existing AWS credentials records managed by Veeam Backup & Replication. Veeam Backup & Replication will use these credentials records to access the following services:

Amazon S3

Amazon EC2

S3 Compatible (including IBM Cloud Object Storage)

Parameters

Parameter	Description	Required	Position	Accept Pipeline Input
Id	Specifies an array of IDs for AWS credentials records. The cmdlet will return AWS credentials records with these IDs.	True	Named	False
AccessKey	Specifies an array of access keys for AWS credentials records. The cmdlet will return AWS credentials records with these access keys.	False	Named	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see the About CommonParameters section of Microsoft Docs.

Return Type

Example 1

This command gets an AWS credentials record by the AWS access key and the AWS ID.

Get-VBRAmazonAccount -AccessKey "XXXXXXXXXXXXXXXXXXXXXXX"

Example 2

This command gets an AWS credentials record by the AWS ID.

Get-VBRAmazonAccount -Id "936edf7c-7cf3-4dbd-9895-c7485ef4bb2c", "936edf7c-7cf3-4ddc-9895-c7485ef4bb2c"