Skip to content

EC2  >  Operations  >  describe_regions

describe_regions

Operation

describe_regions async

describe_regions(request: DescribeRegionsInput | DescribeRegionsInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeRegionsOutput
describe_regions(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeRegionsInputDict]) -> DescribeRegionsOutput

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.

Note

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.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeRegionsOutput

An instance of DescribeRegionsOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeRegionsInput dataclass

Bases: _SerdeShape

Dataclass for DescribeRegionsInput structure.

Attributes
all_regions class-attribute instance-attribute
all_regions: bool | None = ...

Indicates whether to display all Regions, including Regions that are disabled for your account.

dry_run class-attribute instance-attribute
dry_run: bool | None = ...

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 class-attribute instance-attribute
filters: list[Filter] | None = ...

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).

region_names class-attribute instance-attribute
region_names: list[str] | None = ...

The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.

Dictionaries

DescribeRegionsInputDict

Bases: TypedDict

Dictionary form of DescribeRegionsInput.

Attributes
all_regions instance-attribute
all_regions: bool | None

Indicates whether to display all Regions, including Regions that are disabled for your account.

dry_run instance-attribute
dry_run: bool | None

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 instance-attribute
filters: Sequence[Filter | FilterDict] | None

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).

region_names instance-attribute
region_names: Sequence[str] | None

The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.

Output

DescribeRegionsOutput dataclass

Bases: _SerdeShape

Dataclass for DescribeRegionsOutput structure.

Attributes

regions class-attribute instance-attribute
regions: list[Region] | None = ...

Information about the Regions.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.