amazonka-ec2-2.0: Amazon Elastic Compute Cloud SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.EC2.DescribeAvailabilityZones

Description

Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. If there is an event impacting a zone, you can use this request to view the state and any provided messages for that zone.

For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions and zones in the Amazon Elastic Compute Cloud User Guide.

Synopsis

Creating a Request

data DescribeAvailabilityZones Source #

See: newDescribeAvailabilityZones smart constructor.

Constructors

DescribeAvailabilityZones' 

Fields

  • allAvailabilityZones :: Maybe Bool

    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.

  • dryRun :: Maybe Bool

    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 :: Maybe [Filter]

    The filters.

    • group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
    • message - The Zone message.
    • opt-in-status - The opt-in status (opted-in, and not-opted-in | opt-in-not-required).
    • parent-zoneID - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
    • parent-zoneName - 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).
    • 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-type - The type of zone, for example, local-zone.
    • 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, for example, local-zone.
  • zoneIds :: Maybe [Text]

    The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

  • zoneNames :: Maybe [Text]

    The names of the Availability Zones, Local Zones, and Wavelength Zones.

Instances

Instances details
ToHeaders DescribeAvailabilityZones Source # 
Instance details

Defined in Amazonka.EC2.DescribeAvailabilityZones

Methods

toHeaders :: DescribeAvailabilityZones -> [Header] #

ToPath DescribeAvailabilityZones Source # 
Instance details

Defined in Amazonka.EC2.DescribeAvailabilityZones

Methods

toPath :: DescribeAvailabilityZones -> ByteString #

ToQuery DescribeAvailabilityZones Source # 
Instance details

Defined in Amazonka.EC2.DescribeAvailabilityZones

Methods

toQuery :: DescribeAvailabilityZones -> QueryString #

AWSRequest DescribeAvailabilityZones Source # 
Instance details

Defined in Amazonka.EC2.DescribeAvailabilityZones

Associated Types

type AWSResponse DescribeAvailabilityZones #

Methods

request :: (Service -> Service) -> DescribeAvailabilityZones -> Request DescribeAvailabilityZones #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeAvailabilityZones -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAvailabilityZones))) #

Generic DescribeAvailabilityZones Source # 
Instance details

Defined in Amazonka.EC2.DescribeAvailabilityZones

Associated Types

type Rep DescribeAvailabilityZones :: Type -> Type #

Methods

from :: DescribeAvailabilityZones -> Rep DescribeAvailabilityZones x #

to :: Rep DescribeAvailabilityZones x -> DescribeAvailabilityZones #

Read DescribeAvailabilityZones Source # 
Instance details

Defined in Amazonka.EC2.DescribeAvailabilityZones

Methods

readsPrec :: Int -> ReadS DescribeAvailabilityZones #

readList :: ReadS [DescribeAvailabilityZones] #

readPrec :: ReadPrec DescribeAvailabilityZones #

readListPrec :: ReadPrec [DescribeAvailabilityZones] #

Show DescribeAvailabilityZones Source # 
Instance details

Defined in Amazonka.EC2.DescribeAvailabilityZones

Methods

showsPrec :: Int -> DescribeAvailabilityZones -> ShowS #

show :: DescribeAvailabilityZones -> String #

showList :: [DescribeAvailabilityZones] -> ShowS #

NFData DescribeAvailabilityZones Source # 
Instance details

Defined in Amazonka.EC2.DescribeAvailabilityZones

Methods

rnf :: DescribeAvailabilityZones -> () #

Eq DescribeAvailabilityZones Source # 
Instance details

Defined in Amazonka.EC2.DescribeAvailabilityZones

Methods

(==) :: DescribeAvailabilityZones -> DescribeAvailabilityZones -> Bool #

(/=) :: DescribeAvailabilityZones -> DescribeAvailabilityZones -> Bool #

Hashable DescribeAvailabilityZones Source # 
Instance details

Defined in Amazonka.EC2.DescribeAvailabilityZones

Methods

hashWithSalt :: Int -> DescribeAvailabilityZones -> Int #

hash :: DescribeAvailabilityZones -> Int #

type AWSResponse DescribeAvailabilityZones Source # 
Instance details

Defined in Amazonka.EC2.DescribeAvailabilityZones

type AWSResponse DescribeAvailabilityZones = DescribeAvailabilityZonesResponse
type Rep DescribeAvailabilityZones Source # 
Instance details

Defined in Amazonka.EC2.DescribeAvailabilityZones

type Rep DescribeAvailabilityZones = D1 ('MetaData "DescribeAvailabilityZones" "Amazonka.EC2.DescribeAvailabilityZones" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeAvailabilityZones'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allAvailabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :*: (S1 ('MetaSel ('Just "zoneIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "zoneNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newDescribeAvailabilityZones :: DescribeAvailabilityZones Source #

Create a value of DescribeAvailabilityZones with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:allAvailabilityZones:DescribeAvailabilityZones', describeAvailabilityZones_allAvailabilityZones - 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.

$sel:dryRun:DescribeAvailabilityZones', describeAvailabilityZones_dryRun - 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.

$sel:filters:DescribeAvailabilityZones', describeAvailabilityZones_filters - The filters.

  • group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
  • message - The Zone message.
  • opt-in-status - The opt-in status (opted-in, and not-opted-in | opt-in-not-required).
  • parent-zoneID - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
  • parent-zoneName - 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).
  • 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-type - The type of zone, for example, local-zone.
  • 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, for example, local-zone.

$sel:zoneIds:DescribeAvailabilityZones', describeAvailabilityZones_zoneIds - The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

$sel:zoneNames:DescribeAvailabilityZones', describeAvailabilityZones_zoneNames - The names of the Availability Zones, Local Zones, and Wavelength Zones.

Request Lenses

describeAvailabilityZones_allAvailabilityZones :: Lens' DescribeAvailabilityZones (Maybe Bool) Source #

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.

describeAvailabilityZones_dryRun :: Lens' DescribeAvailabilityZones (Maybe Bool) Source #

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.

describeAvailabilityZones_filters :: Lens' DescribeAvailabilityZones (Maybe [Filter]) Source #

The filters.

  • group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
  • message - The Zone message.
  • opt-in-status - The opt-in status (opted-in, and not-opted-in | opt-in-not-required).
  • parent-zoneID - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
  • parent-zoneName - 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).
  • 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-type - The type of zone, for example, local-zone.
  • 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, for example, local-zone.

describeAvailabilityZones_zoneIds :: Lens' DescribeAvailabilityZones (Maybe [Text]) Source #

The IDs of the Availability Zones, Local Zones, and Wavelength Zones.

describeAvailabilityZones_zoneNames :: Lens' DescribeAvailabilityZones (Maybe [Text]) Source #

The names of the Availability Zones, Local Zones, and Wavelength Zones.

Destructuring the Response

data DescribeAvailabilityZonesResponse Source #

See: newDescribeAvailabilityZonesResponse smart constructor.

Constructors

DescribeAvailabilityZonesResponse' 

Fields

Instances

Instances details
Generic DescribeAvailabilityZonesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeAvailabilityZones

Associated Types

type Rep DescribeAvailabilityZonesResponse :: Type -> Type #

Methods

from :: DescribeAvailabilityZonesResponse -> Rep DescribeAvailabilityZonesResponse x #

to :: Rep DescribeAvailabilityZonesResponse x -> DescribeAvailabilityZonesResponse #

Read DescribeAvailabilityZonesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeAvailabilityZones

Methods

readsPrec :: Int -> ReadS DescribeAvailabilityZonesResponse #

readList :: ReadS [DescribeAvailabilityZonesResponse] #

readPrec :: ReadPrec DescribeAvailabilityZonesResponse #

readListPrec :: ReadPrec [DescribeAvailabilityZonesResponse] #

Show DescribeAvailabilityZonesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeAvailabilityZones

Methods

showsPrec :: Int -> DescribeAvailabilityZonesResponse -> ShowS #

show :: DescribeAvailabilityZonesResponse -> String #

showList :: [DescribeAvailabilityZonesResponse] -> ShowS #

NFData DescribeAvailabilityZonesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeAvailabilityZones

Methods

rnf :: DescribeAvailabilityZonesResponse -> () #

Eq DescribeAvailabilityZonesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeAvailabilityZones

Methods

(==) :: DescribeAvailabilityZonesResponse -> DescribeAvailabilityZonesResponse -> Bool #

(/=) :: DescribeAvailabilityZonesResponse -> DescribeAvailabilityZonesResponse -> Bool #

type Rep DescribeAvailabilityZonesResponse Source # 
Instance details

Defined in Amazonka.EC2.DescribeAvailabilityZones

type Rep DescribeAvailabilityZonesResponse = D1 ('MetaData "DescribeAvailabilityZonesResponse" "Amazonka.EC2.DescribeAvailabilityZones" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeAvailabilityZonesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "availabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AvailabilityZone])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeAvailabilityZonesResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeAvailabilityZonesResponse'

-> DescribeAvailabilityZonesResponse 

Create a value of DescribeAvailabilityZonesResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeAvailabilityZonesResponse, describeAvailabilityZonesResponse_availabilityZones - Information about the Availability Zones, Local Zones, and Wavelength Zones.

$sel:httpStatus:DescribeAvailabilityZonesResponse', describeAvailabilityZonesResponse_httpStatus - The response's http status code.

Response Lenses

describeAvailabilityZonesResponse_availabilityZones :: Lens' DescribeAvailabilityZonesResponse (Maybe [AvailabilityZone]) Source #

Information about the Availability Zones, Local Zones, and Wavelength Zones.

describeAvailabilityZonesResponse_httpStatus :: Lens' DescribeAvailabilityZonesResponse Int Source #

The response's http status code.