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.DescribeDBProxyEndpoints

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about DB proxy endpoints.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDBProxyEndpoints Source #

See: newDescribeDBProxyEndpoints smart constructor.

Constructors

DescribeDBProxyEndpoints'

Fields

dbProxyEndpointName :: Maybe Text
The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.
dbProxyName :: Maybe Text
The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.
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 DescribeDBProxyEndpoints Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints Methods toHeaders :: DescribeDBProxyEndpoints -> [Header] #
ToPath DescribeDBProxyEndpoints Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints Methods toPath :: DescribeDBProxyEndpoints -> ByteString #
ToQuery DescribeDBProxyEndpoints Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints Methods toQuery :: DescribeDBProxyEndpoints -> QueryString #
AWSPager DescribeDBProxyEndpoints Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints Methods page :: DescribeDBProxyEndpoints -> AWSResponse DescribeDBProxyEndpoints -> Maybe DescribeDBProxyEndpoints #
AWSRequest DescribeDBProxyEndpoints Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints Associated Types type AWSResponse DescribeDBProxyEndpoints # Methods request :: (Service -> Service) -> DescribeDBProxyEndpoints -> Request DescribeDBProxyEndpoints # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDBProxyEndpoints -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDBProxyEndpoints))) #
Generic DescribeDBProxyEndpoints Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints Associated Types type Rep DescribeDBProxyEndpoints :: Type -> Type # Methods from :: DescribeDBProxyEndpoints -> Rep DescribeDBProxyEndpoints x # to :: Rep DescribeDBProxyEndpoints x -> DescribeDBProxyEndpoints #
Read DescribeDBProxyEndpoints Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints Methods readsPrec :: Int -> ReadS DescribeDBProxyEndpoints # readList :: ReadS [DescribeDBProxyEndpoints] # readPrec :: ReadPrec DescribeDBProxyEndpoints # readListPrec :: ReadPrec [DescribeDBProxyEndpoints] #
Show DescribeDBProxyEndpoints Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints Methods showsPrec :: Int -> DescribeDBProxyEndpoints -> ShowS # show :: DescribeDBProxyEndpoints -> String # showList :: [DescribeDBProxyEndpoints] -> ShowS #
NFData DescribeDBProxyEndpoints Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints Methods rnf :: DescribeDBProxyEndpoints -> () #
Eq DescribeDBProxyEndpoints Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints Methods (==) :: DescribeDBProxyEndpoints -> DescribeDBProxyEndpoints -> Bool # (/=) :: DescribeDBProxyEndpoints -> DescribeDBProxyEndpoints -> Bool #
Hashable DescribeDBProxyEndpoints Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints Methods hashWithSalt :: Int -> DescribeDBProxyEndpoints -> Int # hash :: DescribeDBProxyEndpoints -> Int #
type AWSResponse DescribeDBProxyEndpoints Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints type AWSResponse DescribeDBProxyEndpoints = DescribeDBProxyEndpointsResponse
type Rep DescribeDBProxyEndpoints Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints type Rep DescribeDBProxyEndpoints = D1 ('MetaData "DescribeDBProxyEndpoints" "Amazonka.RDS.DescribeDBProxyEndpoints" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeDBProxyEndpoints'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbProxyEndpointName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: 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))))))

newDescribeDBProxyEndpoints :: DescribeDBProxyEndpoints Source #

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

DescribeDBProxyEndpoints, describeDBProxyEndpoints_dbProxyEndpointName - The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.

DescribeDBProxyEndpoints, describeDBProxyEndpoints_dbProxyName - The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.

$sel:filters:DescribeDBProxyEndpoints', describeDBProxyEndpoints_filters - This parameter is not currently supported.

DescribeDBProxyEndpoints, describeDBProxyEndpoints_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:DescribeDBProxyEndpoints', describeDBProxyEndpoints_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

describeDBProxyEndpoints_dbProxyEndpointName :: Lens' DescribeDBProxyEndpoints (Maybe Text) Source #

The name of a DB proxy endpoint to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with the specified proxy.

describeDBProxyEndpoints_dbProxyName :: Lens' DescribeDBProxyEndpoints (Maybe Text) Source #

The name of the DB proxy whose endpoints you want to describe. If you omit this parameter, the output includes information about all DB proxy endpoints associated with all your DB proxies.

describeDBProxyEndpoints_filters :: Lens' DescribeDBProxyEndpoints (Maybe [Filter]) Source #

This parameter is not currently supported.

describeDBProxyEndpoints_marker :: Lens' DescribeDBProxyEndpoints (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.

describeDBProxyEndpoints_maxRecords :: Lens' DescribeDBProxyEndpoints (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 DescribeDBProxyEndpointsResponse Source #

See: newDescribeDBProxyEndpointsResponse smart constructor.

Constructors

DescribeDBProxyEndpointsResponse'
Fields dbProxyEndpoints :: Maybe [DBProxyEndpoint] The list of `ProxyEndpoint` objects returned by the API operation. 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 DescribeDBProxyEndpointsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints Associated Types type Rep DescribeDBProxyEndpointsResponse :: Type -> Type # Methods from :: DescribeDBProxyEndpointsResponse -> Rep DescribeDBProxyEndpointsResponse x # to :: Rep DescribeDBProxyEndpointsResponse x -> DescribeDBProxyEndpointsResponse #
Read DescribeDBProxyEndpointsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints Methods readsPrec :: Int -> ReadS DescribeDBProxyEndpointsResponse # readList :: ReadS [DescribeDBProxyEndpointsResponse] # readPrec :: ReadPrec DescribeDBProxyEndpointsResponse # readListPrec :: ReadPrec [DescribeDBProxyEndpointsResponse] #
Show DescribeDBProxyEndpointsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints Methods showsPrec :: Int -> DescribeDBProxyEndpointsResponse -> ShowS # show :: DescribeDBProxyEndpointsResponse -> String # showList :: [DescribeDBProxyEndpointsResponse] -> ShowS #
NFData DescribeDBProxyEndpointsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints Methods rnf :: DescribeDBProxyEndpointsResponse -> () #
Eq DescribeDBProxyEndpointsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints Methods (==) :: DescribeDBProxyEndpointsResponse -> DescribeDBProxyEndpointsResponse -> Bool # (/=) :: DescribeDBProxyEndpointsResponse -> DescribeDBProxyEndpointsResponse -> Bool #
type Rep DescribeDBProxyEndpointsResponse Source #
Instance details Defined in Amazonka.RDS.DescribeDBProxyEndpoints type Rep DescribeDBProxyEndpointsResponse = D1 ('MetaData "DescribeDBProxyEndpointsResponse" "Amazonka.RDS.DescribeDBProxyEndpoints" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeDBProxyEndpointsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbProxyEndpoints") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBProxyEndpoint])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBProxyEndpointsResponse Source #

Arguments

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

Create a value of DescribeDBProxyEndpointsResponse 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:dbProxyEndpoints:DescribeDBProxyEndpointsResponse', describeDBProxyEndpointsResponse_dbProxyEndpoints - The list of ProxyEndpoint objects returned by the API operation.

DescribeDBProxyEndpoints, describeDBProxyEndpointsResponse_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:DescribeDBProxyEndpointsResponse', describeDBProxyEndpointsResponse_httpStatus - The response's http status code.

Response Lenses

describeDBProxyEndpointsResponse_dbProxyEndpoints :: Lens' DescribeDBProxyEndpointsResponse (Maybe [DBProxyEndpoint]) Source #

The list of ProxyEndpoint objects returned by the API operation.

describeDBProxyEndpointsResponse_marker :: Lens' DescribeDBProxyEndpointsResponse (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.

describeDBProxyEndpointsResponse_httpStatus :: Lens' DescribeDBProxyEndpointsResponse Int Source #

The response's http status code.