amazonka-rds-2.0: Amazon Relational Database Service 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.RDS.DescribeDBProxyTargets

Description

Returns information about DBProxyTarget objects. This API supports pagination.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDBProxyTargets Source #

See: newDescribeDBProxyTargets smart constructor.

Constructors

DescribeDBProxyTargets' 

Fields

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

  • targetGroupName :: Maybe Text

    The identifier of the DBProxyTargetGroup to describe.

  • dbProxyName :: Text

    The identifier of the DBProxyTarget to describe.

Instances

Instances details
ToHeaders DescribeDBProxyTargets Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

ToPath DescribeDBProxyTargets Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

ToQuery DescribeDBProxyTargets Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

AWSPager DescribeDBProxyTargets Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

AWSRequest DescribeDBProxyTargets Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

Associated Types

type AWSResponse DescribeDBProxyTargets #

Generic DescribeDBProxyTargets Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

Associated Types

type Rep DescribeDBProxyTargets :: Type -> Type #

Read DescribeDBProxyTargets Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

Show DescribeDBProxyTargets Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

NFData DescribeDBProxyTargets Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

Methods

rnf :: DescribeDBProxyTargets -> () #

Eq DescribeDBProxyTargets Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

Hashable DescribeDBProxyTargets Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

type AWSResponse DescribeDBProxyTargets Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

type Rep DescribeDBProxyTargets Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

type Rep DescribeDBProxyTargets = D1 ('MetaData "DescribeDBProxyTargets" "Amazonka.RDS.DescribeDBProxyTargets" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeDBProxyTargets'" 'PrefixI 'True) ((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)) :*: (S1 ('MetaSel ('Just "targetGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "dbProxyName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribeDBProxyTargets Source #

Create a value of DescribeDBProxyTargets 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:DescribeDBProxyTargets', describeDBProxyTargets_filters - This parameter is not currently supported.

DescribeDBProxyTargets, describeDBProxyTargets_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:DescribeDBProxyTargets', describeDBProxyTargets_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.

DescribeDBProxyTargets, describeDBProxyTargets_targetGroupName - The identifier of the DBProxyTargetGroup to describe.

DescribeDBProxyTargets, describeDBProxyTargets_dbProxyName - The identifier of the DBProxyTarget to describe.

Request Lenses

describeDBProxyTargets_filters :: Lens' DescribeDBProxyTargets (Maybe [Filter]) Source #

This parameter is not currently supported.

describeDBProxyTargets_marker :: Lens' DescribeDBProxyTargets (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.

describeDBProxyTargets_maxRecords :: Lens' DescribeDBProxyTargets (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.

describeDBProxyTargets_targetGroupName :: Lens' DescribeDBProxyTargets (Maybe Text) Source #

The identifier of the DBProxyTargetGroup to describe.

describeDBProxyTargets_dbProxyName :: Lens' DescribeDBProxyTargets Text Source #

The identifier of the DBProxyTarget to describe.

Destructuring the Response

data DescribeDBProxyTargetsResponse Source #

See: newDescribeDBProxyTargetsResponse smart constructor.

Constructors

DescribeDBProxyTargetsResponse' 

Fields

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

  • targets :: Maybe [DBProxyTarget]

    An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribeDBProxyTargetsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

Associated Types

type Rep DescribeDBProxyTargetsResponse :: Type -> Type #

Read DescribeDBProxyTargetsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

Show DescribeDBProxyTargetsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

NFData DescribeDBProxyTargetsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

Eq DescribeDBProxyTargetsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

type Rep DescribeDBProxyTargetsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBProxyTargets

type Rep DescribeDBProxyTargetsResponse = D1 ('MetaData "DescribeDBProxyTargetsResponse" "Amazonka.RDS.DescribeDBProxyTargets" "amazonka-rds-2.0-3xXyiLHmAvvCXXUIx1uhpP" 'False) (C1 ('MetaCons "DescribeDBProxyTargetsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBProxyTarget])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBProxyTargetsResponse Source #

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

DescribeDBProxyTargets, describeDBProxyTargetsResponse_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:targets:DescribeDBProxyTargetsResponse', describeDBProxyTargetsResponse_targets - An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.

$sel:httpStatus:DescribeDBProxyTargetsResponse', describeDBProxyTargetsResponse_httpStatus - The response's http status code.

Response Lenses

describeDBProxyTargetsResponse_marker :: Lens' DescribeDBProxyTargetsResponse (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.

describeDBProxyTargetsResponse_targets :: Lens' DescribeDBProxyTargetsResponse (Maybe [DBProxyTarget]) Source #

An arbitrary number of DBProxyTarget objects, containing details of the corresponding targets.