Get-VBRAmazonS3Region

Short Description

Returns Amazon S3 regions.

Applies to

Platform: VMware, Hyper-V

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

Syntax

Get-VBRAmazonS3Region -Connection <IVBRAmazonS3Connection> [-RegionId <string>] [<CommonParameters>]

Detailed Description

This cmdlet returns an array of Amazon S3 regions. You can get regions for the following services:

Parameters

Parameters
Parameter	Description	Type	Required	Position	Accept Pipeline Input
Connection	Specifies an active session with AWS. The cmdlet will return an array of all Amazon S3 regions from this session.	Accepts the IVBRAmazonS3Connection object. To get this object, run the Connect-VBRAmazonS3Service cmdlet.	True	Named	False
RegionId	Specifies an ID of Amazon S3 region. The cmdlet will return an array of Amazon S3 regions with these IDs.	String	False	Named	False

This cmdlet supports Microsoft PowerShell common parameters. For more information on common parameters, see Microsoft Docs.

Output Object

VBRAmazonS3Region

Examples

Example 1. Getting Amazon S3 Regions

This example shows how to get Amazon S3 regions.

$account = Get-VBRAmazonAccount -Id "936edf7c-7cf3-4dbd-9895-c7485ef4bb2c"

$connection = Connect-VBRAmazonS3Service -Account $account -RegionType Global -ServiceType CapacityTier

Get-VBRAmazonS3Region -Connection $connection

Perform the following steps:

Run the Get-VBRAmazonAccount cmdlet. Specify the Id parameter value. Save the result to the $account variable.
Run the Connect-VBRAmazonS3Service cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType and ServiceType parameter values. Save the result to the $connection variable.
Run the Get-VBRAmazonS3Region cmdlet. Set the $connection variable as the Connection parameter value.

Example 2. Getting Amazon S3 Regions for Amazon S3 Object Storage

This example shows how to get Amazon S3 regions for Amazon S3 object storage.

$account = Get-VBRAmazonAccount -Id "936edf7c-7cf3-4dbd-9895-c7485ef4bb2c"

$connection = Connect-VBRAmazonS3Service -Account $account -RegionType Global -ServiceType CapacityTier

Get-VBRAmazonS3Region -Connection $connection -RegionId "eu-west-3"

Perform the following steps:

Run the Get-VBRAmazonAccount cmdlet. Specify the Id parameter value. Save the result to the $account variable.
Run the Connect-VBRAmazonS3Service cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType and ServiceType parameter values. Save the result to the $connection variable.
Run the Get-VBRAmazonS3Region cmdlet. Set the $connection variable as the Connection parameter value. Specify the RegionId parameter value.

Related Commands