Amazonka.DocumentDB.DescribeDBSubnetGroups

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.

Creating a Request

data DescribeDBSubnetGroups

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

ToHeaders DescribeDBSubnetGroups

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Methods

toHeaders :: DescribeDBSubnetGroups -> [Header]

ToPath DescribeDBSubnetGroups

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Methods

toPath :: DescribeDBSubnetGroups -> ByteString

ToQuery DescribeDBSubnetGroups

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Methods

toQuery :: DescribeDBSubnetGroups -> QueryString

AWSPager DescribeDBSubnetGroups

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Methods

page :: DescribeDBSubnetGroups -> AWSResponse DescribeDBSubnetGroups -> Maybe DescribeDBSubnetGroups

AWSRequest DescribeDBSubnetGroups

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Associated Types

type AWSResponse DescribeDBSubnetGroups

Methods

request :: (Service -> Service) -> DescribeDBSubnetGroups -> Request DescribeDBSubnetGroups

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeDBSubnetGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDBSubnetGroups)))

Generic DescribeDBSubnetGroups

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Associated Types

type Rep DescribeDBSubnetGroups :: Type -> Type

Methods

from :: DescribeDBSubnetGroups -> Rep DescribeDBSubnetGroups x

to :: Rep DescribeDBSubnetGroups x -> DescribeDBSubnetGroups

Read DescribeDBSubnetGroups

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Methods

readsPrec :: Int -> ReadS DescribeDBSubnetGroups

readList :: ReadS [DescribeDBSubnetGroups]

readPrec :: ReadPrec DescribeDBSubnetGroups

readListPrec :: ReadPrec [DescribeDBSubnetGroups]

Show DescribeDBSubnetGroups

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Methods

showsPrec :: Int -> DescribeDBSubnetGroups -> ShowS

show :: DescribeDBSubnetGroups -> String

showList :: [DescribeDBSubnetGroups] -> ShowS

NFData DescribeDBSubnetGroups

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Methods

rnf :: DescribeDBSubnetGroups -> ()

Eq DescribeDBSubnetGroups

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Methods

(==) :: DescribeDBSubnetGroups -> DescribeDBSubnetGroups -> Bool

(/=) :: DescribeDBSubnetGroups -> DescribeDBSubnetGroups -> Bool

Hashable DescribeDBSubnetGroups

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Methods

hashWithSalt :: Int -> DescribeDBSubnetGroups -> Int

hash :: DescribeDBSubnetGroups -> Int

type AWSResponse DescribeDBSubnetGroups

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

type AWSResponse DescribeDBSubnetGroups = DescribeDBSubnetGroupsResponse

type Rep DescribeDBSubnetGroups

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

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)

The name of the subnet group to return details for.

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

This parameter is not currently supported.

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

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

Destructuring the Response

data DescribeDBSubnetGroupsResponse

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

Generic DescribeDBSubnetGroupsResponse

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Associated Types

type Rep DescribeDBSubnetGroupsResponse :: Type -> Type

Methods

from :: DescribeDBSubnetGroupsResponse -> Rep DescribeDBSubnetGroupsResponse x

to :: Rep DescribeDBSubnetGroupsResponse x -> DescribeDBSubnetGroupsResponse

Read DescribeDBSubnetGroupsResponse

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Methods

readsPrec :: Int -> ReadS DescribeDBSubnetGroupsResponse

readList :: ReadS [DescribeDBSubnetGroupsResponse]

readPrec :: ReadPrec DescribeDBSubnetGroupsResponse

readListPrec :: ReadPrec [DescribeDBSubnetGroupsResponse]

Show DescribeDBSubnetGroupsResponse

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Methods

showsPrec :: Int -> DescribeDBSubnetGroupsResponse -> ShowS

show :: DescribeDBSubnetGroupsResponse -> String

showList :: [DescribeDBSubnetGroupsResponse] -> ShowS

NFData DescribeDBSubnetGroupsResponse

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Methods

rnf :: DescribeDBSubnetGroupsResponse -> ()

Eq DescribeDBSubnetGroupsResponse

Defined in Amazonka.DocumentDB.DescribeDBSubnetGroups

Methods

(==) :: DescribeDBSubnetGroupsResponse -> DescribeDBSubnetGroupsResponse -> Bool

(/=) :: DescribeDBSubnetGroupsResponse -> DescribeDBSubnetGroupsResponse -> Bool

type Rep DescribeDBSubnetGroupsResponse

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

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.

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])

Detailed information about one or more subnet groups.

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

describeDBSubnetGroupsResponse_httpStatus :: Lens' DescribeDBSubnetGroupsResponse Int

The response's http status code.