Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.RDS.DescribeDBProxies

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about DB proxies.

This operation returns paginated results.

Synopsis

data DescribeDBProxies = DescribeDBProxies' {
- dbProxyName :: Maybe Text
- filters :: Maybe [Filter]
- marker :: Maybe Text
- maxRecords :: Maybe Natural
}
newDescribeDBProxies :: DescribeDBProxies
describeDBProxies_dbProxyName :: Lens' DescribeDBProxies (Maybe Text)
describeDBProxies_filters :: Lens' DescribeDBProxies (Maybe [Filter])
describeDBProxies_marker :: Lens' DescribeDBProxies (Maybe Text)
describeDBProxies_maxRecords :: Lens' DescribeDBProxies (Maybe Natural)
data DescribeDBProxiesResponse = DescribeDBProxiesResponse' {
- dbProxies :: Maybe [DBProxy]
- marker :: Maybe Text
- httpStatus :: Int
}
newDescribeDBProxiesResponse :: Int -> DescribeDBProxiesResponse
describeDBProxiesResponse_dbProxies :: Lens' DescribeDBProxiesResponse (Maybe [DBProxy])
describeDBProxiesResponse_marker :: Lens' DescribeDBProxiesResponse (Maybe Text)
describeDBProxiesResponse_httpStatus :: Lens' DescribeDBProxiesResponse Int

Creating a Request

data DescribeDBProxies Source #

See: newDescribeDBProxies smart constructor.

Constructors

DescribeDBProxies'

Fields

dbProxyName :: Maybe Text
The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID.
filters :: Maybe [Filter]
This parameter is not currently supported.
marker :: Maybe Text
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
maxRecords :: Maybe Natural
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 that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.

Instances

Instances details

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

newDescribeDBProxies :: DescribeDBProxies Source #

Create a value of DescribeDBProxies 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:

DescribeDBProxies, describeDBProxies_dbProxyName - The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID.

$sel:filters:DescribeDBProxies', describeDBProxies_filters - This parameter is not currently supported.

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

$sel:maxRecords:DescribeDBProxies', describeDBProxies_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 that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Request Lenses

describeDBProxies_dbProxyName :: Lens' DescribeDBProxies (Maybe Text) Source #

The name of the DB proxy. If you omit this parameter, the output includes information about all DB proxies owned by your Amazon Web Services account ID.

describeDBProxies_filters :: Lens' DescribeDBProxies (Maybe [Filter]) Source #

This parameter is not currently supported.

describeDBProxies_marker :: Lens' DescribeDBProxies (Maybe Text) Source #

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

describeDBProxies_maxRecords :: Lens' DescribeDBProxies (Maybe Natural) 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 that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Destructuring the Response

data DescribeDBProxiesResponse Source #

See: newDescribeDBProxiesResponse smart constructor.

Constructors

DescribeDBProxiesResponse'
Fields dbProxies :: Maybe [DBProxy] A return value representing an arbitrary number of `DBProxy` data structures. marker :: Maybe Text An optional pagination token provided by a previous 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

Generic DescribeDBProxiesResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxies Associated Types type Rep DescribeDBProxiesResponse :: Type -> Type # Methods from :: DescribeDBProxiesResponse -> Rep DescribeDBProxiesResponse x # to :: Rep DescribeDBProxiesResponse x -> DescribeDBProxiesResponse #
Read DescribeDBProxiesResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxies Methods readsPrec :: Int -> ReadS DescribeDBProxiesResponse # readList :: ReadS [DescribeDBProxiesResponse] # readPrec :: ReadPrec DescribeDBProxiesResponse # readListPrec :: ReadPrec [DescribeDBProxiesResponse] #
Show DescribeDBProxiesResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxies Methods showsPrec :: Int -> DescribeDBProxiesResponse -> ShowS # show :: DescribeDBProxiesResponse -> String # showList :: [DescribeDBProxiesResponse] -> ShowS #
NFData DescribeDBProxiesResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxies Methods rnf :: DescribeDBProxiesResponse -> () #
Eq DescribeDBProxiesResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxies Methods (==) :: DescribeDBProxiesResponse -> DescribeDBProxiesResponse -> Bool # (/=) :: DescribeDBProxiesResponse -> DescribeDBProxiesResponse -> Bool #
type Rep DescribeDBProxiesResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxies type Rep DescribeDBProxiesResponse = D1 ('MetaData "DescribeDBProxiesResponse" "Amazonka.RDS.DescribeDBProxies" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeDBProxiesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbProxies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBProxy])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBProxiesResponse Source #

Arguments

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

Create a value of DescribeDBProxiesResponse 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:dbProxies:DescribeDBProxiesResponse', describeDBProxiesResponse_dbProxies - A return value representing an arbitrary number of DBProxy data structures.

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

$sel:httpStatus:DescribeDBProxiesResponse', describeDBProxiesResponse_httpStatus - The response's http status code.

Response Lenses

describeDBProxiesResponse_dbProxies :: Lens' DescribeDBProxiesResponse (Maybe [DBProxy]) Source #

A return value representing an arbitrary number of DBProxy data structures.

describeDBProxiesResponse_marker :: Lens' DescribeDBProxiesResponse (Maybe Text) Source #

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

describeDBProxiesResponse_httpStatus :: Lens' DescribeDBProxiesResponse Int Source #

The response's http status code.