amazonka-docdb-2.0: Amazon DocumentDB with MongoDB compatibility 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.DocumentDB.DescribeDBSubnetGroups

Description

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

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeDBSubnetGroups Source #

Represents the input to DescribeDBSubnetGroups.

See: newDescribeDBSubnetGroups smart constructor.

Constructors

DescribeDBSubnetGroups' 

Fields

  • dbSubnetGroupName :: Maybe Text

    The name of the subnet group to return details for.

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

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (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 DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

ToPath DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

ToQuery DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

AWSPager DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

AWSRequest DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Associated Types

type AWSResponse DescribeDBSubnetGroups #

Generic DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Associated Types

type Rep DescribeDBSubnetGroups :: Type -> Type #

Read DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Show DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

NFData DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Methods

rnf :: DescribeDBSubnetGroups -> () #

Eq DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Hashable DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

type AWSResponse DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

type Rep DescribeDBSubnetGroups Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

type Rep DescribeDBSubnetGroups = D1 ('MetaData "DescribeDBSubnetGroups" "Amazonka.DocumentDB.DescribeDBSubnetGroups" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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)))))

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:

DescribeDBSubnetGroups, describeDBSubnetGroups_dbSubnetGroupName - The name of the subnet group to return details for.

$sel:filters:DescribeDBSubnetGroups', describeDBSubnetGroups_filters - This parameter is not currently supported.

DescribeDBSubnetGroups, describeDBSubnetGroups_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: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 (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Request Lenses

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

The name of the subnet group to return details for.

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

This parameter is not currently supported.

describeDBSubnetGroups_marker :: Lens' DescribeDBSubnetGroups (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.

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 (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 DescribeDBSubnetGroupsResponse Source #

Represents the output of DescribeDBSubnetGroups.

See: newDescribeDBSubnetGroupsResponse smart constructor.

Constructors

DescribeDBSubnetGroupsResponse' 

Fields

  • dbSubnetGroups :: Maybe [DBSubnetGroup]

    Detailed information about one or more subnet groups.

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

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Associated Types

type Rep DescribeDBSubnetGroupsResponse :: Type -> Type #

Read DescribeDBSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Show DescribeDBSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

NFData DescribeDBSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Eq DescribeDBSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

type Rep DescribeDBSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

type Rep DescribeDBSubnetGroupsResponse = D1 ('MetaData "DescribeDBSubnetGroupsResponse" "Amazonka.DocumentDB.DescribeDBSubnetGroups" "amazonka-docdb-2.0-7OwFe1BulfiBtMsDpDrdzX" '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 - Detailed information about one or more subnet groups.

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.