Get-VBOAmazonS3Folder

Short Description

Returns Amazon S3 folders.

Syntax

Get-VBOAmazonS3Folder -Bucket <VBOAmazonS3Bucket> [-Name <string>] [<CommonParameters>]

Detailed Description

This cmdlet returns the VBOAmazonS3Folder 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

Parameters

Parameter

Description

Type

Required

Position

Accept Pipeline Input

Accept Wildcard Characters

Bucket

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

Accepts the VBOAmazonS3Bucket object. To get this object, run the Get-VBOAmazonS3Bucket cmdlet.

True

Named

False

 

Name

Specifies a name of the Amazon S3 folder. The cmdlet will return the folder with this name.

String

False

Named

False

 

<CommonParameters>

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

Output Object

The cmdlet returns the VBOAmazonS3Folder object that contains an array of Amazon S3 folders.

Examples

Get-VBOAmazonS3FolderExample 1. Getting Amazon S3 Folders

This example shows how to get Amazon S3 folders.

$account = Get-VBOAmazonS3Account -Id "26e61916-0257-4a05-8f65-204628d2ed7a"

$connection = New-VBOAmazonS3ServiceConnectionSettings -Account $account -ServerName "Reports" -Port 5544

$bucket = Get-VBOAmazonS3Bucket -AmazonS3ConnectionSettings $connection -Region EUStockholm

Get-VBOAmazonS3Folder -Bucket $bucket -Name "Reports 09"

Perform the following steps:

  1. Run the Get-VBOAmazonS3Account cmdlet. Specify the ID parameter value. Save the result to the $account variable.
  2. Run the New-VBOAmazonS3ServiceConnectionSettings cmdlet. Set the $account variable as the Account parameter value. Specify the RegionType parameter value. Save the result to the $connection variable.
  1. Run the Get-VBOAmazonS3Bucket cmdlet. Set the $connection variable as the AmazonS3ConnectionSettings parameter value. Specify the Region parameter value. Save the result to the $bucket variable.
  2. Run the Get-VBOAmazonS3Folder cmdlet. Set the $bucket variable as the Bucket parameter value. Specify the Name parameter value.

Get-VBOAmazonS3FolderExample 2. Getting S3 Compatible Folders

This example shows how to get S3 Compatible folders.

$account = Get-VBOAmazonS3CompatibleAccount -Id "26e61916-0257-4a05-8f65-204628d2ed7a"

$connection = New-VBOAmazonS3CompatibleConnectionSettings -Account $account -ServicePoint "172.17.186.13:9000"

$bucket = Get-VBOAmazonS3Bucket -AmazonS3ConnectionSettings $connection -Region EUIreland

Get-VBOAmazonS3Folder -Bucket $bucket -Name "Reports 09"

Perform the following steps:

  1. Run the Get-VBOAmazonS3Account cmdlet. Specify the ID parameter value. Save the result to the $account variable.
  2. Run the New-VBOAmazonS3CompatibleConnectionSettings cmdlet. Specify the necessary parameters. Save the result to the $connection variable.
  3. Run the Get-VBOAmazonS3Bucket cmdlet. Specify the necessary parameters. Save the result to the $bucket variable.
  1. Run the Get-VBOAmazonS3Folder cmdlet. Set the $bucket variable as the Bucket parameter value. Specify the Name parameter value.

Related Commands

I want to report a typo

There is a misspelling right here:

 

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