Get-VBRAmazonS3Region

In this article

    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:

    • Amazon S3
    • S3 Compatible (including IBM Cloud Object Storage)

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Connection

    Specifies an active session with AWS. The cmdlet will return an array of all Amazon S3 regions from this session.

    Accepts the <IVBRAmazonS3Connection> type.

    True

    Named

    False

     

    RegionId

    Specifies an ID of Amazon S3 region. The cmdlet will return an array of Amazon S3 regions with these IDs.

    False

    Named

    False

     

    <CommonParameters>

    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 example shows how to get Amazon S3 regions.

    1. Run Get-VBRAmazonAccount to get the AWS credentials record. Save the result to the $account variable.
    2. Run Connect-VBRAmazonS3Service with the $account variable to connect to AWS. Save the result to the $connection variable.
    3. Run Get-VBRAmazonS3Region with the $connection variable.

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

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

    Get-VBRAmazonS3Region -Connection $connection

    Example 2

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

    1. Run Get-VBRAmazonAccount to get the Amazon S3 credentials record. Save the result to the $account variable.
    2. Run Connect-VBRAmazonS3Service with the $account variable to connect to Amazon S3 object storage. Save the result to the $connection variable.
    3. Run Get-VBRAmazonS3Region with the $connection and $bucket variables. Use the RegionId parameter for Amazon S3 region.

    $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"

    Related Commands

    Get-VBRAmazonAccount

    Connect-VBRAmazonS3Service

    I want to report a typo

    There is a misspelling right here:

     

    I want to let the Veeam Documentation Team know about that.