libZSservicesZSamazonka-dynamodb-daxZSamazonka-dynamodb-dax
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.DAX.DescribeSubnetGroups

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

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

Read DescribeSubnetGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeSubnetGroups

Show DescribeSubnetGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeSubnetGroups

Generic DescribeSubnetGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeSubnetGroups

Associated Types

type Rep DescribeSubnetGroups :: Type -> Type #

NFData DescribeSubnetGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeSubnetGroups

Methods

rnf :: DescribeSubnetGroups -> () #

Hashable DescribeSubnetGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeSubnetGroups

ToJSON DescribeSubnetGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeSubnetGroups

AWSPager DescribeSubnetGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeSubnetGroups

AWSRequest DescribeSubnetGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeSubnetGroups

Associated Types

type AWSResponse DescribeSubnetGroups #

ToHeaders DescribeSubnetGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeSubnetGroups

ToPath DescribeSubnetGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeSubnetGroups

ToQuery DescribeSubnetGroups Source # 
Instance details

Defined in Amazonka.DAX.DescribeSubnetGroups

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

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_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

Instances

Instances details
Eq DescribeSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.DAX.DescribeSubnetGroups

Read DescribeSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.DAX.DescribeSubnetGroups

Show DescribeSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.DAX.DescribeSubnetGroups

Generic DescribeSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.DAX.DescribeSubnetGroups

Associated Types

type Rep DescribeSubnetGroupsResponse :: Type -> Type #

NFData DescribeSubnetGroupsResponse Source # 
Instance details

Defined in Amazonka.DAX.DescribeSubnetGroups

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 #

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.