AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Returns the set of available AWS regions.

Syntax

PublicOnly (Default)

Get-AWSRegion
-SystemName <String>
-IncludeChina <SwitchParameter>

PublicAndGovCloud

Get-AWSRegion
-SystemName <String>
-IncludeChina <SwitchParameter>
-IncludeGovCloud <SwitchParameter>

GovCloudOnly

Get-AWSRegion
-GovCloudOnly <SwitchParameter>

Description

Returns the set of available AWS regions.

Parameters

-GovCloudOnly <SwitchParameter>
If set the returned collection contains only the 'Gov Cloud' region(s).Default: off.
Required?False
Position?Named
Accept pipeline input?False
-IncludeChina <SwitchParameter>
Include the China (Beijing) region in the returned collection of AWSRegion instances. Note that use of this region requires an alternate set of credentials.This switch is ignored if the SystemName parameter is used to request a specific AWSRegion instance. To return the specific China (Beijing) region, specify a value of 'cn-north-1' for the SystemName parameter.Default: off.
Required?False
Position?Named
Accept pipeline input?False
-IncludeGovCloud <SwitchParameter>
If set the returned collection includes 'Gov Cloud' region(s).Default: off.
Required?False
Position?Named
Accept pipeline input?False
-SystemName <String>
If set returns an AWSRegion instance corresponding to the specified system name (e.g. us-west-2).This parameter can also be used to return AWSRegion instances for the US GovCloud and China (Beijing) regions by specifying the relevant system name.
Required?False
Position?1
Accept pipeline input?True (ByValue, )

Inputs

You can pipe a String object to this cmdlet for the SystemName parameter.

Outputs

AWSRegion
AWSRegion instance for each available region.

Supported Version

AWS Tools for PowerShell: 2.x.y.z