Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.DocumentDB.DescribeDBSubnetGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data DescribeDBSubnetGroups = DescribeDBSubnetGroups' {
- dbSubnetGroupName :: Maybe Text
- filters :: Maybe [Filter]
- marker :: Maybe Text
- maxRecords :: Maybe Int
}
newDescribeDBSubnetGroups :: DescribeDBSubnetGroups
describeDBSubnetGroups_dbSubnetGroupName :: Lens' DescribeDBSubnetGroups (Maybe Text)
describeDBSubnetGroups_filters :: Lens' DescribeDBSubnetGroups (Maybe [Filter])
describeDBSubnetGroups_marker :: Lens' DescribeDBSubnetGroups (Maybe Text)
describeDBSubnetGroups_maxRecords :: Lens' DescribeDBSubnetGroups (Maybe Int)
data DescribeDBSubnetGroupsResponse = DescribeDBSubnetGroupsResponse' {
- dbSubnetGroups :: Maybe [DBSubnetGroup]
- marker :: Maybe Text
- httpStatus :: Int
}
newDescribeDBSubnetGroupsResponse :: Int -> DescribeDBSubnetGroupsResponse
describeDBSubnetGroupsResponse_dbSubnetGroups :: Lens' DescribeDBSubnetGroupsResponse (Maybe [DBSubnetGroup])
describeDBSubnetGroupsResponse_marker :: Lens' DescribeDBSubnetGroupsResponse (Maybe Text)
describeDBSubnetGroupsResponse_httpStatus :: Lens' DescribeDBSubnetGroupsResponse Int

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

Eq DescribeDBSubnetGroups Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups Methods (==) :: DescribeDBSubnetGroups -> DescribeDBSubnetGroups -> Bool # (/=) :: DescribeDBSubnetGroups -> DescribeDBSubnetGroups -> Bool #
Read DescribeDBSubnetGroups Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups Methods readsPrec :: Int -> ReadS DescribeDBSubnetGroups # readList :: ReadS [DescribeDBSubnetGroups] # readPrec :: ReadPrec DescribeDBSubnetGroups # readListPrec :: ReadPrec [DescribeDBSubnetGroups] #
Show DescribeDBSubnetGroups Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups Methods showsPrec :: Int -> DescribeDBSubnetGroups -> ShowS # show :: DescribeDBSubnetGroups -> String # showList :: [DescribeDBSubnetGroups] -> ShowS #
Generic DescribeDBSubnetGroups Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups Associated Types type Rep DescribeDBSubnetGroups :: Type -> Type # Methods from :: DescribeDBSubnetGroups -> Rep DescribeDBSubnetGroups x # to :: Rep DescribeDBSubnetGroups x -> DescribeDBSubnetGroups #
NFData DescribeDBSubnetGroups Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups Methods rnf :: DescribeDBSubnetGroups -> () #
Hashable DescribeDBSubnetGroups Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups Methods hashWithSalt :: Int -> DescribeDBSubnetGroups -> Int # hash :: DescribeDBSubnetGroups -> Int #
AWSPager DescribeDBSubnetGroups Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups Methods page :: DescribeDBSubnetGroups -> AWSResponse DescribeDBSubnetGroups -> Maybe DescribeDBSubnetGroups #
AWSRequest DescribeDBSubnetGroups Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups Associated Types type AWSResponse DescribeDBSubnetGroups # Methods request :: DescribeDBSubnetGroups -> Request DescribeDBSubnetGroups # response :: MonadResource m => Logger -> Service -> Proxy DescribeDBSubnetGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDBSubnetGroups))) #
ToHeaders DescribeDBSubnetGroups Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups Methods toHeaders :: DescribeDBSubnetGroups -> [Header] #
ToPath DescribeDBSubnetGroups Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups Methods toPath :: DescribeDBSubnetGroups -> ByteString #
ToQuery DescribeDBSubnetGroups Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups Methods toQuery :: DescribeDBSubnetGroups -> QueryString #
type Rep DescribeDBSubnetGroups Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups type Rep DescribeDBSubnetGroups = D1 ('MetaData "DescribeDBSubnetGroups" "Amazonka.DocumentDB.DescribeDBSubnetGroups" "libZSservicesZSamazonka-docdbZSamazonka-docdb" '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.DocumentDB.DescribeDBSubnetGroups type AWSResponse DescribeDBSubnetGroups = DescribeDBSubnetGroupsResponse

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 subnet group to return details for.

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

$sel:marker: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

Eq DescribeDBSubnetGroupsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups Methods (==) :: DescribeDBSubnetGroupsResponse -> DescribeDBSubnetGroupsResponse -> Bool # (/=) :: DescribeDBSubnetGroupsResponse -> DescribeDBSubnetGroupsResponse -> Bool #
Read DescribeDBSubnetGroupsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups Methods readsPrec :: Int -> ReadS DescribeDBSubnetGroupsResponse # readList :: ReadS [DescribeDBSubnetGroupsResponse] # readPrec :: ReadPrec DescribeDBSubnetGroupsResponse # readListPrec :: ReadPrec [DescribeDBSubnetGroupsResponse] #
Show DescribeDBSubnetGroupsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups Methods showsPrec :: Int -> DescribeDBSubnetGroupsResponse -> ShowS # show :: DescribeDBSubnetGroupsResponse -> String # showList :: [DescribeDBSubnetGroupsResponse] -> ShowS #
Generic DescribeDBSubnetGroupsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups Associated Types type Rep DescribeDBSubnetGroupsResponse :: Type -> Type # Methods from :: DescribeDBSubnetGroupsResponse -> Rep DescribeDBSubnetGroupsResponse x # to :: Rep DescribeDBSubnetGroupsResponse x -> DescribeDBSubnetGroupsResponse #
NFData DescribeDBSubnetGroupsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups Methods rnf :: DescribeDBSubnetGroupsResponse -> () #
type Rep DescribeDBSubnetGroupsResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups type Rep DescribeDBSubnetGroupsResponse = D1 ('MetaData "DescribeDBSubnetGroupsResponse" "Amazonka.DocumentDB.DescribeDBSubnetGroups" "libZSservicesZSamazonka-docdbZSamazonka-docdb" '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 #

Arguments

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

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.

$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_dbSubnetGroups :: Lens' DescribeDBSubnetGroupsResponse (Maybe [DBSubnetGroup]) Source #

Detailed information about one or more subnet groups.

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.

describeDBSubnetGroupsResponse_httpStatus :: Lens' DescribeDBSubnetGroupsResponse Int Source #

The response's http status code.