DescribeRegionsRequest Class | AWS SDK for .NET Version 4

Container for the parameters to the DescribeRegions operation. Describes the Regions that are enabled for your account, or all Regions.

For a list of the Regions supported by Amazon EC2, see Amazon EC2 service endpoints.

For information about enabling and disabling Regions for your account, see Specify which Amazon Web Services Regions your account can use in the Amazon Web Services Account Management Reference Guide.

The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.DescribeRegionsRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

public class DescribeRegionsRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The DescribeRegionsRequest type exposes the following members

Constructors

	Name	Description
	DescribeRegionsRequest()

Properties

Name	Type	Description
AllRegions	System.Nullable<System.Boolean>	Gets and sets the property AllRegions. Indicates whether to display all Regions, including Regions that are disabled for your account.
DryRun	System.Nullable<System.Boolean>	Gets and sets the property DryRun. Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.
Filters	System.Collections.Generic.List<Amazon.EC2.Model.Filter>	Gets and sets the property Filters. The filters. `endpoint` - The endpoint of the Region (for example, `ec2.us-east-1.amazonaws.com`). `opt-in-status` - The opt-in status of the Region (`opt-in-not-required` \| `opted-in` \| `not-opted-in`). `region-name` - The name of the Region (for example, `us-east-1`). Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
RegionNames	System.Collections.Generic.List<System.String>	Gets and sets the property RegionNames. The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.

Examples

This example describes all the regions that are available to you.

To describe your regions


var client = new AmazonEC2Client();
var response = client.DescribeRegions(new DescribeRegionsRequest 
{
});

List<Region> regions = response.Regions;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer