libZSservicesZSamazonka-rdsZSamazonka-rds
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.RDS.DescribeDBSubnetGroups

Description

Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.

For an overview of CIDR ranges, go to the Wikipedia Tutorial.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDBSubnetGroups Source #

See: newDescribeDBSubnetGroups smart constructor.

Constructors

DescribeDBSubnetGroups' 

Fields

  • dbSubnetGroupName :: Maybe Text

    The name of the DB subnet group to return details for.

  • filters :: Maybe [Filter]

    This parameter isn't currently supported.

  • marker :: Maybe Text

    An optional pagination token provided by a previous DescribeDBSubnetGroups 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 that you can retrieve the remaining results.

    Default: 100

    Constraints: Minimum 20, maximum 100.

Instances

Instances details
Eq DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

Read DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

Show DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

Generic DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

Associated Types

type Rep DescribeDBSubnetGroups :: Type -> Type #

NFData DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

Methods

rnf :: DescribeDBSubnetGroups -> () #

Hashable DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

AWSPager DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

AWSRequest DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

Associated Types

type AWSResponse DescribeDBSubnetGroups #

ToHeaders DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

ToPath DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

ToQuery DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

type Rep DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

type Rep DescribeDBSubnetGroups = D1 ('MetaData "DescribeDBSubnetGroups" "Amazonka.RDS.DescribeDBSubnetGroups" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DescribeDBSubnetGroups'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbSubnetGroupName") '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 Int)))))
type AWSResponse DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

newDescribeDBSubnetGroups :: DescribeDBSubnetGroups Source #

Create a value of DescribeDBSubnetGroups 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:dbSubnetGroupName:DescribeDBSubnetGroups', describeDBSubnetGroups_dbSubnetGroupName - The name of the DB subnet group to return details for.

$sel:filters:DescribeDBSubnetGroups', describeDBSubnetGroups_filters - This parameter isn't currently supported.

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

$sel:maxRecords:DescribeDBSubnetGroups', describeDBSubnetGroups_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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Request Lenses

describeDBSubnetGroups_dbSubnetGroupName :: Lens' DescribeDBSubnetGroups (Maybe Text) Source #

The name of the DB subnet group to return details for.

describeDBSubnetGroups_filters :: Lens' DescribeDBSubnetGroups (Maybe [Filter]) Source #

This parameter isn't currently supported.

describeDBSubnetGroups_marker :: Lens' DescribeDBSubnetGroups (Maybe Text) Source #

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

describeDBSubnetGroups_maxRecords :: Lens' DescribeDBSubnetGroups (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 that you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Destructuring the Response

data DescribeDBSubnetGroupsResponse Source #

Contains the result of a successful invocation of the DescribeDBSubnetGroups action.

See: newDescribeDBSubnetGroupsResponse smart constructor.

Constructors

DescribeDBSubnetGroupsResponse' 

Fields

  • dbSubnetGroups :: Maybe [DBSubnetGroup]

    A list of DBSubnetGroup instances.

  • 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
Eq DescribeDBSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

Read DescribeDBSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

Show DescribeDBSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

Generic DescribeDBSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

Associated Types

type Rep DescribeDBSubnetGroupsResponse :: Type -> Type #

NFData DescribeDBSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

type Rep DescribeDBSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.RDS.DescribeDBSubnetGroups

type Rep DescribeDBSubnetGroupsResponse = D1 ('MetaData "DescribeDBSubnetGroupsResponse" "Amazonka.RDS.DescribeDBSubnetGroups" "libZSservicesZSamazonka-rdsZSamazonka-rds" 'False) (C1 ('MetaCons "DescribeDBSubnetGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbSubnetGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBSubnetGroup])) :*: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBSubnetGroupsResponse Source #

Create a value of DescribeDBSubnetGroupsResponse 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:dbSubnetGroups:DescribeDBSubnetGroupsResponse', describeDBSubnetGroupsResponse_dbSubnetGroups - A list of DBSubnetGroup instances.

$sel:marker:DescribeDBSubnetGroups', describeDBSubnetGroupsResponse_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:DescribeDBSubnetGroupsResponse', describeDBSubnetGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describeDBSubnetGroupsResponse_marker :: Lens' DescribeDBSubnetGroupsResponse (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.