Skip to content

DescribeRegionsRequest

Source code in docs_src/capo_ec2/types/describe_regions_request.py 
15
16
17
18
19
20
21
22
23
24
25
class DescribeRegionsRequest(TypedDict, closed=True):
    region_names: NotRequired[
        "capo_ec2.types.region_name_string_list.RegionNameStringList"
    ]
    """<p>The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account.</p>"""
    all_regions: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether to display all Regions, including Regions that are disabled for your account.</p>"""
    dry_run: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>"""
    filters: NotRequired["capo_ec2.types.filter_list.FilterList"]
    """<p>The filters.</p> <ul> <li> <p> <code>endpoint</code> - The endpoint of the Region (for example, <code>ec2.us-east-1.amazonaws.com</code>).</p> </li> <li> <p> <code>opt-in-status</code> - The opt-in status of the Region (<code>opt-in-not-required</code> | <code>opted-in</code> | <code>not-opted-in</code>).</p> </li> <li> <p> <code>region-name</code> - The name of the Region (for example, <code>us-east-1</code>).</p> </li> </ul>"""

all_regions instance-attribute 

all_regions: NotRequired[Boolean]

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

dry_run instance-attribute 

dry_run: NotRequired[Boolean]

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: NotRequired[FilterList]

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: NotRequired[RegionNameStringList]

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