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.DAX.DescribeSubnetGroups

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns a list of subnet group descriptions. If a subnet group name is specified, the list will contain only the description of that group.

This operation returns paginated results.

Synopsis

data DescribeSubnetGroups = DescribeSubnetGroups' {
- subnetGroupNames :: Maybe [Text]
- nextToken :: Maybe Text
- maxResults :: Maybe Int
}
newDescribeSubnetGroups :: DescribeSubnetGroups
describeSubnetGroups_subnetGroupNames :: Lens' DescribeSubnetGroups (Maybe [Text])
describeSubnetGroups_nextToken :: Lens' DescribeSubnetGroups (Maybe Text)
describeSubnetGroups_maxResults :: Lens' DescribeSubnetGroups (Maybe Int)
data DescribeSubnetGroupsResponse = DescribeSubnetGroupsResponse' {
- subnetGroups :: Maybe [SubnetGroup]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newDescribeSubnetGroupsResponse :: Int -> DescribeSubnetGroupsResponse
describeSubnetGroupsResponse_subnetGroups :: Lens' DescribeSubnetGroupsResponse (Maybe [SubnetGroup])
describeSubnetGroupsResponse_nextToken :: Lens' DescribeSubnetGroupsResponse (Maybe Text)
describeSubnetGroupsResponse_httpStatus :: Lens' DescribeSubnetGroupsResponse Int

Creating a Request

data DescribeSubnetGroups Source #

See: newDescribeSubnetGroups smart constructor.

Constructors

DescribeSubnetGroups'

Fields

subnetGroupNames :: Maybe [Text]
The name of the subnet group.
nextToken :: Maybe Text
An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.
maxResults :: Maybe Int
The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
The value for MaxResults must be between 20 and 100.

Instances

Instances details

Eq DescribeSubnetGroups Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups Methods (==) :: DescribeSubnetGroups -> DescribeSubnetGroups -> Bool # (/=) :: DescribeSubnetGroups -> DescribeSubnetGroups -> Bool #
Read DescribeSubnetGroups Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups Methods readsPrec :: Int -> ReadS DescribeSubnetGroups # readList :: ReadS [DescribeSubnetGroups] # readPrec :: ReadPrec DescribeSubnetGroups # readListPrec :: ReadPrec [DescribeSubnetGroups] #
Show DescribeSubnetGroups Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups Methods showsPrec :: Int -> DescribeSubnetGroups -> ShowS # show :: DescribeSubnetGroups -> String # showList :: [DescribeSubnetGroups] -> ShowS #
Generic DescribeSubnetGroups Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups Associated Types type Rep DescribeSubnetGroups :: Type -> Type # Methods from :: DescribeSubnetGroups -> Rep DescribeSubnetGroups x # to :: Rep DescribeSubnetGroups x -> DescribeSubnetGroups #
NFData DescribeSubnetGroups Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups Methods rnf :: DescribeSubnetGroups -> () #
Hashable DescribeSubnetGroups Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups Methods hashWithSalt :: Int -> DescribeSubnetGroups -> Int # hash :: DescribeSubnetGroups -> Int #
ToJSON DescribeSubnetGroups Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups Methods toJSON :: DescribeSubnetGroups -> Value # toEncoding :: DescribeSubnetGroups -> Encoding # toJSONList :: [DescribeSubnetGroups] -> Value # toEncodingList :: [DescribeSubnetGroups] -> Encoding #
AWSPager DescribeSubnetGroups Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups Methods page :: DescribeSubnetGroups -> AWSResponse DescribeSubnetGroups -> Maybe DescribeSubnetGroups #
AWSRequest DescribeSubnetGroups Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups Associated Types type AWSResponse DescribeSubnetGroups # Methods request :: DescribeSubnetGroups -> Request DescribeSubnetGroups # response :: MonadResource m => Logger -> Service -> Proxy DescribeSubnetGroups -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSubnetGroups))) #
ToHeaders DescribeSubnetGroups Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups Methods toHeaders :: DescribeSubnetGroups -> [Header] #
ToPath DescribeSubnetGroups Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups Methods toPath :: DescribeSubnetGroups -> ByteString #
ToQuery DescribeSubnetGroups Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups Methods toQuery :: DescribeSubnetGroups -> QueryString #
type Rep DescribeSubnetGroups Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups type Rep DescribeSubnetGroups = D1 ('MetaData "DescribeSubnetGroups" "Amazonka.DAX.DescribeSubnetGroups" "libZSservicesZSamazonka-dynamodb-daxZSamazonka-dynamodb-dax" 'False) (C1 ('MetaCons "DescribeSubnetGroups'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subnetGroupNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))
type AWSResponse DescribeSubnetGroups Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups type AWSResponse DescribeSubnetGroups = DescribeSubnetGroupsResponse

newDescribeSubnetGroups :: DescribeSubnetGroups Source #

Create a value of DescribeSubnetGroups 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:subnetGroupNames:DescribeSubnetGroups', describeSubnetGroups_subnetGroupNames - The name of the subnet group.

$sel:nextToken:DescribeSubnetGroups', describeSubnetGroups_nextToken - An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

$sel:maxResults:DescribeSubnetGroups', describeSubnetGroups_maxResults - The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

Request Lenses

describeSubnetGroups_subnetGroupNames :: Lens' DescribeSubnetGroups (Maybe [Text]) Source #

The name of the subnet group.

describeSubnetGroups_nextToken :: Lens' DescribeSubnetGroups (Maybe Text) Source #

An optional token returned from a prior request. Use this token for pagination of results from this action. If this parameter is specified, the response includes only results beyond the token, up to the value specified by MaxResults.

describeSubnetGroups_maxResults :: Lens' DescribeSubnetGroups (Maybe Int) Source #

The maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

The value for MaxResults must be between 20 and 100.

Destructuring the Response

data DescribeSubnetGroupsResponse Source #

See: newDescribeSubnetGroupsResponse smart constructor.

Constructors

DescribeSubnetGroupsResponse'
Fields subnetGroups :: Maybe [SubnetGroup] An array of subnet groups. Each element in the array represents a single subnet group. nextToken :: Maybe Text Provides an identifier to allow retrieval of paginated results. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeSubnetGroupsResponse Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups Methods (==) :: DescribeSubnetGroupsResponse -> DescribeSubnetGroupsResponse -> Bool # (/=) :: DescribeSubnetGroupsResponse -> DescribeSubnetGroupsResponse -> Bool #
Read DescribeSubnetGroupsResponse Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups Methods readsPrec :: Int -> ReadS DescribeSubnetGroupsResponse # readList :: ReadS [DescribeSubnetGroupsResponse] # readPrec :: ReadPrec DescribeSubnetGroupsResponse # readListPrec :: ReadPrec [DescribeSubnetGroupsResponse] #
Show DescribeSubnetGroupsResponse Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups Methods showsPrec :: Int -> DescribeSubnetGroupsResponse -> ShowS # show :: DescribeSubnetGroupsResponse -> String # showList :: [DescribeSubnetGroupsResponse] -> ShowS #
Generic DescribeSubnetGroupsResponse Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups Associated Types type Rep DescribeSubnetGroupsResponse :: Type -> Type # Methods from :: DescribeSubnetGroupsResponse -> Rep DescribeSubnetGroupsResponse x # to :: Rep DescribeSubnetGroupsResponse x -> DescribeSubnetGroupsResponse #
NFData DescribeSubnetGroupsResponse Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups Methods rnf :: DescribeSubnetGroupsResponse -> () #
type Rep DescribeSubnetGroupsResponse Source #
Instance details Defined in Amazonka.DAX.DescribeSubnetGroups type Rep DescribeSubnetGroupsResponse = D1 ('MetaData "DescribeSubnetGroupsResponse" "Amazonka.DAX.DescribeSubnetGroups" "libZSservicesZSamazonka-dynamodb-daxZSamazonka-dynamodb-dax" 'False) (C1 ('MetaCons "DescribeSubnetGroupsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subnetGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SubnetGroup])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeSubnetGroupsResponse Source #

Arguments

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

Create a value of DescribeSubnetGroupsResponse 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:subnetGroups:DescribeSubnetGroupsResponse', describeSubnetGroupsResponse_subnetGroups - An array of subnet groups. Each element in the array represents a single subnet group.

$sel:nextToken:DescribeSubnetGroups', describeSubnetGroupsResponse_nextToken - Provides an identifier to allow retrieval of paginated results.

$sel:httpStatus:DescribeSubnetGroupsResponse', describeSubnetGroupsResponse_httpStatus - The response's http status code.

Response Lenses

describeSubnetGroupsResponse_subnetGroups :: Lens' DescribeSubnetGroupsResponse (Maybe [SubnetGroup]) Source #

An array of subnet groups. Each element in the array represents a single subnet group.

describeSubnetGroupsResponse_nextToken :: Lens' DescribeSubnetGroupsResponse (Maybe Text) Source #

Provides an identifier to allow retrieval of paginated results.

describeSubnetGroupsResponse_httpStatus :: Lens' DescribeSubnetGroupsResponse Int Source #

The response's http status code.