Amazonka.RDS.DescribeDBProxies

Returns information about DB proxies.

This operation returns paginated results.

Creating a Request

data DescribeDBProxies

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

ToHeaders DescribeDBProxies

Defined in Amazonka.RDS.DescribeDBProxies

Methods

toHeaders :: DescribeDBProxies -> [Header]

ToPath DescribeDBProxies

Defined in Amazonka.RDS.DescribeDBProxies

Methods

toPath :: DescribeDBProxies -> ByteString

ToQuery DescribeDBProxies

Defined in Amazonka.RDS.DescribeDBProxies

Methods

toQuery :: DescribeDBProxies -> QueryString

AWSPager DescribeDBProxies

Defined in Amazonka.RDS.DescribeDBProxies

Methods

page :: DescribeDBProxies -> AWSResponse DescribeDBProxies -> Maybe DescribeDBProxies

AWSRequest DescribeDBProxies

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

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

Defined in Amazonka.RDS.DescribeDBProxies

Methods

readsPrec :: Int -> ReadS DescribeDBProxies

readList :: ReadS [DescribeDBProxies]

readPrec :: ReadPrec DescribeDBProxies

readListPrec :: ReadPrec [DescribeDBProxies]

Show DescribeDBProxies

Defined in Amazonka.RDS.DescribeDBProxies

Methods

showsPrec :: Int -> DescribeDBProxies -> ShowS

show :: DescribeDBProxies -> String

showList :: [DescribeDBProxies] -> ShowS

NFData DescribeDBProxies

Defined in Amazonka.RDS.DescribeDBProxies

Methods

rnf :: DescribeDBProxies -> ()

Eq DescribeDBProxies

Defined in Amazonka.RDS.DescribeDBProxies

Methods

(==) :: DescribeDBProxies -> DescribeDBProxies -> Bool

(/=) :: DescribeDBProxies -> DescribeDBProxies -> Bool

Hashable DescribeDBProxies

Defined in Amazonka.RDS.DescribeDBProxies

Methods

hashWithSalt :: Int -> DescribeDBProxies -> Int

hash :: DescribeDBProxies -> Int

type AWSResponse DescribeDBProxies

Defined in Amazonka.RDS.DescribeDBProxies

type AWSResponse DescribeDBProxies = DescribeDBProxiesResponse

type Rep DescribeDBProxies

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

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)

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])

This parameter is not currently supported.

describeDBProxies_marker :: Lens' DescribeDBProxies (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.

describeDBProxies_maxRecords :: Lens' DescribeDBProxies (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.

Destructuring the Response

data DescribeDBProxiesResponse

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

Generic DescribeDBProxiesResponse

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

Defined in Amazonka.RDS.DescribeDBProxies

Methods

readsPrec :: Int -> ReadS DescribeDBProxiesResponse

readList :: ReadS [DescribeDBProxiesResponse]

readPrec :: ReadPrec DescribeDBProxiesResponse

readListPrec :: ReadPrec [DescribeDBProxiesResponse]

Show DescribeDBProxiesResponse

Defined in Amazonka.RDS.DescribeDBProxies

Methods

showsPrec :: Int -> DescribeDBProxiesResponse -> ShowS

show :: DescribeDBProxiesResponse -> String

showList :: [DescribeDBProxiesResponse] -> ShowS

NFData DescribeDBProxiesResponse

Defined in Amazonka.RDS.DescribeDBProxies

Methods

rnf :: DescribeDBProxiesResponse -> ()

Eq DescribeDBProxiesResponse

Defined in Amazonka.RDS.DescribeDBProxies

Methods

(==) :: DescribeDBProxiesResponse -> DescribeDBProxiesResponse -> Bool

(/=) :: DescribeDBProxiesResponse -> DescribeDBProxiesResponse -> Bool

type Rep DescribeDBProxiesResponse

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

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])

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

describeDBProxiesResponse_marker :: Lens' DescribeDBProxiesResponse (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.

describeDBProxiesResponse_httpStatus :: Lens' DescribeDBProxiesResponse Int

The response's http status code.