Skip to content

EC2  >  Structures  >  AvailabilityZone

AvailabilityZone

Structure Class

AvailabilityZone dataclass

Bases: _SerdeShape

Describes Availability Zones, Local Zones, and Wavelength Zones.

Attributes

geography class-attribute instance-attribute 
geography: list[AvailabilityZoneGeography] | None = ...

The geography information for the Availability Zone or Local Zone. The geography is returned as a list.

group_long_name class-attribute instance-attribute 
group_long_name: str | None = ...

The long name of the Availability Zone group, Local Zone group, or Wavelength Zone group.

group_name class-attribute instance-attribute 
group_name: str | None = ...

The name of the zone group. For example:

  • Availability Zones - us-east-1-zg-1

  • Local Zones - us-west-2-lax-1

  • Wavelength Zones - us-east-1-wl1-bos-wlz-1

messages class-attribute instance-attribute 
messages: list[AvailabilityZoneMessage] | None = ...

Any messages about the Availability Zone, Local Zone, or Wavelength Zone.

network_border_group class-attribute instance-attribute 
network_border_group: str | None = ...

The name of the network border group.

opt_in_status class-attribute instance-attribute 
opt_in_status: str | None = ...

For Availability Zones, this parameter always has the value of opt-in-not-required.

For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible values are opted-in and not-opted-in.

parent_zone_id class-attribute instance-attribute 
parent_zone_id: str | None = ...

The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.

parent_zone_name class-attribute instance-attribute 
parent_zone_name: str | None = ...

The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.

region_name class-attribute instance-attribute 
region_name: str | None = ...

The name of the Region.

state class-attribute instance-attribute 
state: str | None = ...

The state of the Availability Zone, Local Zone, or Wavelength Zone. The possible values are available, unavailable, and constrained.

sub_geography class-attribute instance-attribute 
sub_geography: list[AvailabilityZoneSubGeography] | None = ...

The sub-geography information for the Availability Zone or Local Zone. The sub-geography is returned as a list.

zone_id class-attribute instance-attribute 
zone_id: str | None = ...

The ID of the Availability Zone, Local Zone, or Wavelength Zone.

zone_name class-attribute instance-attribute 
zone_name: str | None = ...

The name of the Availability Zone, Local Zone, or Wavelength Zone.

zone_type class-attribute instance-attribute 
zone_type: str | None = ...

The type of zone.

Valid values: availability-zone | local-zone | wavelength-zone