Get-VBOAmazonS3Bucket

In this article

    Short Description

    Returns Amazon S3 buckets.

    Syntax

    This cmdlet provides parameter sets that allow you to:

    • Get Amazon S3 buckets.

    Get-VBOAmazonS3Bucket -AmazonS3ConnectionSettings <VBOAmazonS3ConnectionSettings> [-Name <string>] [-RegionId <string>] [<CommonParameters>]

    • Get S3 Compatible buckets.

    Get-VBOAmazonS3Bucket -AmazonS3CompatibleConnectionSettings <VBOAmazonS3CompatibleConnectionSettings> [-Name <string>]  [<CommonParameters>]

    Detailed Description

    This cmdlet returns the VBRAmazonS3Bucket object that contains an array of Amazon buckets for the following Amazon services:

    • Amazon S3
    • S3 Compatible

    Parameters

    Parameter

    Description

    Type

    Required

    Position

    Accept Pipeline Input

     

    AmazonS3ConnectionSettings

    Specifies an active session with Amazon object storage. The cmdlet will return an array of Amazon S3 buckets for this Amazon object storage.

    Accepts the VBOAmazonS3ConnectionSettings object.

    To create this object, run the New-VBOAmazonS3ConnectionSettings cmdlet.

    True

    Named

    False

     

    AmazonS3CompatibleConnection
    Settings

    Specifies an active session with S3 Compatible object storage. The cmdlet will return an array of Amazon S3 buckets for this S3 Compatible object storage.

    Accepts the VBOAmazonS3CompatibleConnectionSettings object.

    To create this object, run the New-VBOAmazonS3CompatibleConnectionSettings cmdlet.

    True

    Named

    False

     

    Name

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

    String

    False

    Named

    False

     

    RegionId

    Specifies the region of Amazon S3 object storage. You can select the following region IDs:

    • us-east-2
    • us-east-1
    • us-west-1
    • us-west-2
    • af-south-1
    • ap-east-1
    • ap-southeast-3
    • ap-south-1
    • ap-northeast-3
    • ap-northeast-2
    • ap-southeast-1
    • ap-southeast-2
    • ap-northeast-1
    • ca-central-1
    • eu-central-1
    • eu-west-1
    • eu-west-2
    • eu-south-1
    • eu-west-3
    • eu-north-1
    • me-south-1
    • sa-east-1
    • us-gov-east-1
    • us-gov-west-1

    For more information, see this Amazon article.

    String

    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.

    Output Object

    The cmdlet returns the VBOAmazonS3Bucket object that contains an array of Amazon buckets.

    Examples

    Get-VBOAmazonS3BucketExample 1. Getting Amazon S3 Buckets

    This example shows how to get Amazon S3 buckets.

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

    $connection = New-VBOAmazonS3ConnectionSettings -Account $account -RegionType Global

    Get-VBOAmazonS3Bucket -AmazonS3ConnectionSettings $connection -RegionId eu-north-1

    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-VBOAmazonS3ConnectionSettings 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 RegionId parameter value.

    Get-VBOAmazonS3BucketExample 2. Getting S3 Compatible Buckets

    This example shows how to get S3 Compatible buckets.

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

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

    Get-VBOAmazonS3Bucket -AmazonS3CompatibleConnectionSettings $connection

    Perform the following steps:

    1. Run the Get-VBOAmazonS3CompatibleAccount 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. Set the $connection variable as the AmazonS3CompatibleConnectionSettings parameter value.

    Related Commands