Get-VBRAmazonS3Folder

In this article

    Short Description

    Returns Amazon S3 folders.

    Applies to

    Platform: VMware, Hyper-V

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

    Syntax

    Get-VBRAmazonS3Folder -Connection <IVBRAmazonS3Connection> -Bucket <VBRAmazonS3Bucket> -Name <string>[<CommonParameters>]

    Detailed Description

    This cmdlet returns the VBRAmazonS3Folder object that contains an array of Amazon S3 folders. You can get the array of the folders for the following types of Amazon object storage:

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

    Get-VBRAmazonS3Folder Note:

    The Get-VBRAmazonS3Folder cmdlet will only return the array of Amazon S3 folders that are created under the following paths:

    • [For Capacity Tier] - /Veeam/Archive/
    • [For External Repository] - /Veeam/Backup/

    Parameters

    Parameter

    Description

    Required

    Position

    Accept
    Pipeline
    Input

    Accept
    Wildcard
    Characters

    Connection

    Specifies an active session with Amazon S3 object storage. The cmdlet will return an array of the folders added to this object storage.

    Accepts the IVBRAmazonS3Connection type.

    True

    Named

    False

     

    Bucket

    Specifies an Amazon S3 bucket. The cmdlet will return an array of the folders added to this bucket.

    Accepts the VBRAmazonS3Bucket type.

    True

    Named

    True (ByValue)

     

    Name

    Specifies a name of the Amazon S3 folder. Veeam Backup & Replication will return the folder with this name.

    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 all folders added to Amazon 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-VBRAmazonS3Bucket with the $connection variable to get the Amazon S3 bucket. Save the result to the $bucket variable.
    4. Run Get-VBRAmazonS3Folder with the $connection and $bucket variables.

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

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

    $bucket = Get-VBRAmazonS3Bucket -Connection $connection

    Get-VBRAmazonS3Folder -Connection $connection -Bucket $bucket

    Example 2

    This example shows how to get a folder added to Amazon object storage.

    1. Run Get-VBRAmazonAccount to get Amazon S3 credentials records. 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-VBRAmazonS3Bucket to get the Amazon S3 bucket. Save the result to the $bucket variable
    4. Run Get-VBRAmazonS3Folder with the $connection and $bucket variables. Specify the name of the necessary folder for the Name parameter.

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

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

    $bucket = Get-VBRAmazonS3Bucket -Connection $connection

    Get-VBRAmazonS3Folder -Connection $connection -Bucket $bucket -Name "NewBucket"

    Related Commands

    Get-VBRAmazonAccount

    Connect-VBRAmazonS3Service

    Get-VBRAmazonS3Bucket

    I want to report a typo

    There is a misspelling right here:

     

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