Get-VBOAmazonS3Bucket
Short Description
Returns Amazon S3 buckets.
Syntax
This cmdlet provides parameter sets that allow you to:
- Get Amazon S3 buckets.
Get-VBOAmazonS3Bucket -AmazonS3ConnectionSettings <VBOAmazonS3ConnectionSettings> [-RegionName <string>] [-RegionID {USEastOhio | USEastNVirginia | USWestNCalifornia | USWestOregon | AsiaPacificHongKong | AsiaPacificMumbai | AsiaPacificOsakaLocal | AsiaPacificSeoul | AsiaPacificSingapore | AsiaPacificSydney | AsiaPacificTokyo | CanadaCentral | ChinaBeijing | ChinaNingxia | EUFrankfurt | EUIreland | EULondon | EUParis | EUStockholm |SouthAmericaSaoPaulo}] [<CommonParameters>] |
- Get S3 Compatible buckets.
Get-VBOAmazonS3Bucket -AmazonS3CompatibleConnectionSettings <VBOAmazonS3CompatibleConnectionSettings> [-RegionName <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 | Accept Wildcard Characters |
---|---|---|---|---|---|---|
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. | True | Named | False |
|
AmazonS3CompatibleConnectionSettings | 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. | True | Named | False |
|
RegionName | 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 type of Amazon S3 object storage. The cmdlet will connect to the Amazon S3 bucket in the specified region type. You can select the following types of regions:
|
| 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 VBOAmazonS3Bucket object that contains an array of Amazon buckets.
Examples
Example 1. Getting Amazon S3 Buckets
This example shows how to get Amazon S3 buckets.
Perform the following steps:
|
Example 2. Getting S3 Compatible Buckets
This example shows how to get S3 Compatible buckets.
Perform the following steps:
|
Related Commands