describe_availability_zones¶
Operation¶
describe_availability_zones
async
¶
describe_availability_zones(request: DescribeAvailabilityZonesInput | DescribeAvailabilityZonesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeAvailabilityZonesOutput
describe_availability_zones(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeAvailabilityZonesInputDict]) -> DescribeAvailabilityZonesOutput
Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you.
For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions and zones in the Amazon EC2 User 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 |
|---|---|
DescribeAvailabilityZonesOutput
|
An instance of |
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¶
DescribeAvailabilityZonesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeAvailabilityZonesInput structure.
Attributes¶
all_availability_zones
class-attribute
instance-attribute
¶
all_availability_zones: bool | None = ...
Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.
If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.
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
¶
The filters.
-
group-long-name- The long name of the zone group for the Availability Zone (for example,US West (Oregon) 1), the Local Zone (for example, for Zone groupus-west-2-lax-1, it isUS West (Los Angeles), or the Wavelength Zone (for example, for Zone groupus-east-1-wl1, it isUS East (Verizon). -
group-name- The name of the zone group for the Availability Zone (for example,us-east-1-zg-1), the Local Zone (for example,us-west-2-lax-1), or the Wavelength Zone (for example,us-east-1-wl1). -
message- The Zone message. -
opt-in-status- The opt-in status (opted-in|not-opted-in|opt-in-not-required). -
parent-zone-id- The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls. -
parent-zone-name- The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls. -
region-name- The name of the Region for the Zone (for example,us-east-1). -
state- The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available|unavailable|constrained). -
zone-id- The ID of the Availability Zone (for example,use1-az1), the Local Zone (for example,usw2-lax1-az1), or the Wavelength Zone (for example,us-east-1-wl1-bos-wlz-1). -
zone-name- The name of the Availability Zone (for example,us-east-1a), the Local Zone (for example,us-west-2-lax-1a), or the Wavelength Zone (for example,us-east-1-wl1-bos-wlz-1). -
zone-type- The type of zone (availability-zone|local-zone|wavelength-zone).
zone_ids
class-attribute
instance-attribute
¶
The IDs of the Availability Zones, Local Zones, and Wavelength Zones.
Dictionaries¶
DescribeAvailabilityZonesInputDict
¶
Bases: TypedDict
Dictionary form of DescribeAvailabilityZonesInput.
Attributes¶
all_availability_zones
instance-attribute
¶
all_availability_zones: bool | None
Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.
If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.
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.
-
group-long-name- The long name of the zone group for the Availability Zone (for example,US West (Oregon) 1), the Local Zone (for example, for Zone groupus-west-2-lax-1, it isUS West (Los Angeles), or the Wavelength Zone (for example, for Zone groupus-east-1-wl1, it isUS East (Verizon). -
group-name- The name of the zone group for the Availability Zone (for example,us-east-1-zg-1), the Local Zone (for example,us-west-2-lax-1), or the Wavelength Zone (for example,us-east-1-wl1). -
message- The Zone message. -
opt-in-status- The opt-in status (opted-in|not-opted-in|opt-in-not-required). -
parent-zone-id- The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls. -
parent-zone-name- The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls. -
region-name- The name of the Region for the Zone (for example,us-east-1). -
state- The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available|unavailable|constrained). -
zone-id- The ID of the Availability Zone (for example,use1-az1), the Local Zone (for example,usw2-lax1-az1), or the Wavelength Zone (for example,us-east-1-wl1-bos-wlz-1). -
zone-name- The name of the Availability Zone (for example,us-east-1a), the Local Zone (for example,us-west-2-lax-1a), or the Wavelength Zone (for example,us-east-1-wl1-bos-wlz-1). -
zone-type- The type of zone (availability-zone|local-zone|wavelength-zone).
zone_ids
instance-attribute
¶
The IDs of the Availability Zones, Local Zones, and Wavelength Zones.
Output¶
DescribeAvailabilityZonesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeAvailabilityZonesOutput structure.
Attributes¶
availability_zones
class-attribute
instance-attribute
¶
availability_zones: list[AvailabilityZone] | None = ...
Information about the Availability Zones, Local Zones, and Wavelength Zones.
response_metadata
class-attribute
instance-attribute
¶
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.