Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.RDS.DescribeCustomAvailabilityZones

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about custom Availability Zones (AZs).

A custom AZ is an on-premises AZ that is integrated with a VMware vSphere cluster.

For more information about RDS on VMware, see the RDS on VMware User Guide.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeCustomAvailabilityZones Source #

See: newDescribeCustomAvailabilityZones smart constructor.

Constructors

DescribeCustomAvailabilityZones'

Fields

filters :: Maybe [Filter]
A filter that specifies one or more custom AZs to describe.
customAvailabilityZoneId :: Maybe Text
The custom AZ identifier. If this parameter is specified, information from only the specific custom AZ is returned.
marker :: Maybe Text
An optional pagination token provided by a previous DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
maxRecords :: Maybe Int
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.

Instances

Instances details

Eq DescribeCustomAvailabilityZones Source #
Instance details Defined in Amazonka.RDS.DescribeCustomAvailabilityZones Methods (==) :: DescribeCustomAvailabilityZones -> DescribeCustomAvailabilityZones -> Bool # (/=) :: DescribeCustomAvailabilityZones -> DescribeCustomAvailabilityZones -> Bool #
Read DescribeCustomAvailabilityZones Source #
Instance details Defined in Amazonka.RDS.DescribeCustomAvailabilityZones Methods readsPrec :: Int -> ReadS DescribeCustomAvailabilityZones # readList :: ReadS [DescribeCustomAvailabilityZones] # readPrec :: ReadPrec DescribeCustomAvailabilityZones # readListPrec :: ReadPrec [DescribeCustomAvailabilityZones] #
Show DescribeCustomAvailabilityZones Source #
Instance details Defined in Amazonka.RDS.DescribeCustomAvailabilityZones Methods showsPrec :: Int -> DescribeCustomAvailabilityZones -> ShowS # show :: DescribeCustomAvailabilityZones -> String # showList :: [DescribeCustomAvailabilityZones] -> ShowS #
Generic DescribeCustomAvailabilityZones Source #
Instance details Defined in Amazonka.RDS.DescribeCustomAvailabilityZones Associated Types type Rep DescribeCustomAvailabilityZones :: Type -> Type # Methods from :: DescribeCustomAvailabilityZones -> Rep DescribeCustomAvailabilityZones x # to :: Rep DescribeCustomAvailabilityZones x -> DescribeCustomAvailabilityZones #
NFData DescribeCustomAvailabilityZones Source #
Instance details Defined in Amazonka.RDS.DescribeCustomAvailabilityZones Methods rnf :: DescribeCustomAvailabilityZones -> () #
Hashable DescribeCustomAvailabilityZones Source #
Instance details Defined in Amazonka.RDS.DescribeCustomAvailabilityZones Methods hashWithSalt :: Int -> DescribeCustomAvailabilityZones -> Int # hash :: DescribeCustomAvailabilityZones -> Int #
AWSPager DescribeCustomAvailabilityZones Source #
Instance details Defined in Amazonka.RDS.DescribeCustomAvailabilityZones Methods page :: DescribeCustomAvailabilityZones -> AWSResponse DescribeCustomAvailabilityZones -> Maybe DescribeCustomAvailabilityZones #
AWSRequest DescribeCustomAvailabilityZones Source #
Instance details Defined in Amazonka.RDS.DescribeCustomAvailabilityZones Associated Types type AWSResponse DescribeCustomAvailabilityZones # Methods request :: DescribeCustomAvailabilityZones -> Request DescribeCustomAvailabilityZones # response :: MonadResource m => Logger -> Service -> Proxy DescribeCustomAvailabilityZones -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeCustomAvailabilityZones))) #
ToHeaders DescribeCustomAvailabilityZones Source #
Instance details Defined in Amazonka.RDS.DescribeCustomAvailabilityZones Methods toHeaders :: DescribeCustomAvailabilityZones -> [Header] #
ToPath DescribeCustomAvailabilityZones Source #
Instance details Defined in Amazonka.RDS.DescribeCustomAvailabilityZones Methods toPath :: DescribeCustomAvailabilityZones -> ByteString #
ToQuery DescribeCustomAvailabilityZones Source #
Instance details Defined in Amazonka.RDS.DescribeCustomAvailabilityZones Methods toQuery :: DescribeCustomAvailabilityZones -> QueryString #
type Rep DescribeCustomAvailabilityZones Source #
Instance details Defined in Amazonka.RDS.DescribeCustomAvailabilityZones type Rep DescribeCustomAvailabilityZones = D1 ('MetaData "DescribeCustomAvailabilityZones" "Amazonka.RDS.DescribeCustomAvailabilityZones" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DescribeCustomAvailabilityZones'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])) :: S1 ('MetaSel ('Just "customAvailabilityZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))
type AWSResponse DescribeCustomAvailabilityZones Source #
Instance details Defined in Amazonka.RDS.DescribeCustomAvailabilityZones type AWSResponse DescribeCustomAvailabilityZones = DescribeCustomAvailabilityZonesResponse

newDescribeCustomAvailabilityZones :: DescribeCustomAvailabilityZones Source #

Create a value of DescribeCustomAvailabilityZones 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:filters:DescribeCustomAvailabilityZones', describeCustomAvailabilityZones_filters - A filter that specifies one or more custom AZs to describe.

$sel:customAvailabilityZoneId:DescribeCustomAvailabilityZones', describeCustomAvailabilityZones_customAvailabilityZoneId - The custom AZ identifier. If this parameter is specified, information from only the specific custom AZ is returned.

$sel:marker:DescribeCustomAvailabilityZones', describeCustomAvailabilityZones_marker - An optional pagination token provided by a previous DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:maxRecords:DescribeCustomAvailabilityZones', describeCustomAvailabilityZones_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Request Lenses

describeCustomAvailabilityZones_filters :: Lens' DescribeCustomAvailabilityZones (Maybe [Filter]) Source #

A filter that specifies one or more custom AZs to describe.

describeCustomAvailabilityZones_customAvailabilityZoneId :: Lens' DescribeCustomAvailabilityZones (Maybe Text) Source #

The custom AZ identifier. If this parameter is specified, information from only the specific custom AZ is returned.

describeCustomAvailabilityZones_marker :: Lens' DescribeCustomAvailabilityZones (Maybe Text) Source #

An optional pagination token provided by a previous DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeCustomAvailabilityZones_maxRecords :: Lens' DescribeCustomAvailabilityZones (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Destructuring the Response

data DescribeCustomAvailabilityZonesResponse Source #

See: newDescribeCustomAvailabilityZonesResponse smart constructor.

Constructors

DescribeCustomAvailabilityZonesResponse'

Fields

customAvailabilityZones :: Maybe [CustomAvailabilityZone]
The list of CustomAvailabilityZone objects for the Amazon Web Services account.
marker :: Maybe Text
An optional pagination token provided by a previous DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeCustomAvailabilityZonesResponse Source #
Instance details Defined in Amazonka.RDS.DescribeCustomAvailabilityZones Methods (==) :: DescribeCustomAvailabilityZonesResponse -> DescribeCustomAvailabilityZonesResponse -> Bool # (/=) :: DescribeCustomAvailabilityZonesResponse -> DescribeCustomAvailabilityZonesResponse -> Bool #
Show DescribeCustomAvailabilityZonesResponse Source #
Instance details Defined in Amazonka.RDS.DescribeCustomAvailabilityZones Methods showsPrec :: Int -> DescribeCustomAvailabilityZonesResponse -> ShowS # show :: DescribeCustomAvailabilityZonesResponse -> String # showList :: [DescribeCustomAvailabilityZonesResponse] -> ShowS #
Generic DescribeCustomAvailabilityZonesResponse Source #
Instance details Defined in Amazonka.RDS.DescribeCustomAvailabilityZones Associated Types type Rep DescribeCustomAvailabilityZonesResponse :: Type -> Type # Methods from :: DescribeCustomAvailabilityZonesResponse -> Rep DescribeCustomAvailabilityZonesResponse x # to :: Rep DescribeCustomAvailabilityZonesResponse x -> DescribeCustomAvailabilityZonesResponse #
NFData DescribeCustomAvailabilityZonesResponse Source #
Instance details Defined in Amazonka.RDS.DescribeCustomAvailabilityZones Methods rnf :: DescribeCustomAvailabilityZonesResponse -> () #
type Rep DescribeCustomAvailabilityZonesResponse Source #
Instance details Defined in Amazonka.RDS.DescribeCustomAvailabilityZones type Rep DescribeCustomAvailabilityZonesResponse = D1 ('MetaData "DescribeCustomAvailabilityZonesResponse" "Amazonka.RDS.DescribeCustomAvailabilityZones" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DescribeCustomAvailabilityZonesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "customAvailabilityZones") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [CustomAvailabilityZone])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeCustomAvailabilityZonesResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeCustomAvailabilityZonesResponse'`
-> DescribeCustomAvailabilityZonesResponse

Create a value of DescribeCustomAvailabilityZonesResponse 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:customAvailabilityZones:DescribeCustomAvailabilityZonesResponse', describeCustomAvailabilityZonesResponse_customAvailabilityZones - The list of CustomAvailabilityZone objects for the Amazon Web Services account.

$sel:marker:DescribeCustomAvailabilityZones', describeCustomAvailabilityZonesResponse_marker - An optional pagination token provided by a previous DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:httpStatus:DescribeCustomAvailabilityZonesResponse', describeCustomAvailabilityZonesResponse_httpStatus - The response's http status code.

Response Lenses

describeCustomAvailabilityZonesResponse_customAvailabilityZones :: Lens' DescribeCustomAvailabilityZonesResponse (Maybe [CustomAvailabilityZone]) Source #

The list of CustomAvailabilityZone objects for the Amazon Web Services account.

describeCustomAvailabilityZonesResponse_marker :: Lens' DescribeCustomAvailabilityZonesResponse (Maybe Text) Source #

An optional pagination token provided by a previous DescribeCustomAvailabilityZones request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeCustomAvailabilityZonesResponse_httpStatus :: Lens' DescribeCustomAvailabilityZonesResponse Int Source #

The response's http status code.