Skip to content

AvailabilityZone

Source code in docs_src/capo_ec2/types/availability_zone.py
class AvailabilityZone(TypedDict, closed=True):
    opt_in_status: NotRequired[
        "capo_ec2.types.availability_zone_opt_in_status.AvailabilityZoneOptInStatus"
    ]
    """<p>For Availability Zones, this parameter always has the value of <code>opt-in-not-required</code>.</p> <p>For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible values are <code>opted-in</code> and <code>not-opted-in</code>.</p>"""
    messages: NotRequired[
        "capo_ec2.types.availability_zone_message_list.AvailabilityZoneMessageList"
    ]
    """<p>Any messages about the Availability Zone, Local Zone, or Wavelength Zone.</p>"""
    region_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The name of the Region.</p>"""
    zone_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The name of the Availability Zone, Local Zone, or Wavelength Zone.</p>"""
    zone_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the Availability Zone, Local Zone, or Wavelength Zone.</p>"""
    group_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The name of the zone group. For example:</p> <ul> <li> <p>Availability Zones - <code>us-east-1-zg-1</code> </p> </li> <li> <p>Local Zones - <code>us-west-2-lax-1</code> </p> </li> <li> <p>Wavelength Zones - <code>us-east-1-wl1-bos-wlz-1</code> </p> </li> </ul>"""
    network_border_group: NotRequired["capo_ec2.types.string.String"]
    """<p>The name of the network border group.</p>"""
    zone_type: NotRequired["capo_ec2.types.string.String"]
    """<p>The type of zone.</p> <p>Valid values: <code>availability-zone</code> | <code>local-zone</code> | <code>wavelength-zone</code> </p>"""
    parent_zone_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.</p>"""
    parent_zone_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.</p>"""
    group_long_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The long name of the Availability Zone group, Local Zone group, or Wavelength Zone group.</p>"""
    geography: NotRequired[
        "capo_ec2.types.availability_zone_geography_list.AvailabilityZoneGeographyList"
    ]
    """<p>The geography information for the Availability Zone or Local Zone. The geography is returned as a list.</p>"""
    sub_geography: NotRequired[
        "capo_ec2.types.availability_zone_sub_geography_list.AvailabilityZoneSubGeographyList"
    ]
    """<p>The sub-geography information for the Availability Zone or Local Zone. The sub-geography is returned as a list.</p>"""
    state: NotRequired["capo_ec2.types.availability_zone_state.AvailabilityZoneState"]
    """<p>The state of the Availability Zone, Local Zone, or Wavelength Zone. The possible values are <code>available</code>, <code>unavailable</code>, and <code>constrained</code>.</p>"""

geography instance-attribute

geography: NotRequired[AvailabilityZoneGeographyList]

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

group_long_name instance-attribute

group_long_name: NotRequired[String]

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

group_name instance-attribute

group_name: NotRequired[String]

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 instance-attribute

messages: NotRequired[AvailabilityZoneMessageList]

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

network_border_group instance-attribute

network_border_group: NotRequired[String]

The name of the network border group.

opt_in_status instance-attribute

opt_in_status: NotRequired[AvailabilityZoneOptInStatus]

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 instance-attribute

parent_zone_id: NotRequired[String]

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 instance-attribute

parent_zone_name: NotRequired[String]

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

region_name instance-attribute

region_name: NotRequired[String]

The name of the Region.

state instance-attribute

state: NotRequired[AvailabilityZoneState]

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

sub_geography instance-attribute

sub_geography: NotRequired[AvailabilityZoneSubGeographyList]

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

zone_id instance-attribute

zone_id: NotRequired[String]

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

zone_name instance-attribute

zone_name: NotRequired[String]

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

zone_type instance-attribute

zone_type: NotRequired[String]

The type of zone.

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