| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.MemoryDb.DescribeSubnetGroups
Description
Returns a list of subnet group descriptions. If a subnet group name is specified, the list contains only the description of that group.
This operation returns paginated results.
Synopsis
- data DescribeSubnetGroups = DescribeSubnetGroups' {
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- subnetGroupName :: Maybe Text
- newDescribeSubnetGroups :: DescribeSubnetGroups
- describeSubnetGroups_maxResults :: Lens' DescribeSubnetGroups (Maybe Int)
- describeSubnetGroups_nextToken :: Lens' DescribeSubnetGroups (Maybe Text)
- describeSubnetGroups_subnetGroupName :: Lens' DescribeSubnetGroups (Maybe Text)
- data DescribeSubnetGroupsResponse = DescribeSubnetGroupsResponse' {
- nextToken :: Maybe Text
- subnetGroups :: Maybe [SubnetGroup]
- httpStatus :: Int
- newDescribeSubnetGroupsResponse :: Int -> DescribeSubnetGroupsResponse
- describeSubnetGroupsResponse_nextToken :: Lens' DescribeSubnetGroupsResponse (Maybe Text)
- describeSubnetGroupsResponse_subnetGroups :: Lens' DescribeSubnetGroupsResponse (Maybe [SubnetGroup])
- describeSubnetGroupsResponse_httpStatus :: Lens' DescribeSubnetGroupsResponse Int
Creating a Request
data DescribeSubnetGroups Source #
See: newDescribeSubnetGroups smart constructor.
Constructors
| DescribeSubnetGroups' | |
Fields
| |
Instances
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:maxResults:DescribeSubnetGroups', describeSubnetGroups_maxResults - The maximum number of records to include in the response. If more
records exist than the specified MaxResults value, a token is included
in the response so that the remaining results can be retrieved.
DescribeSubnetGroups, describeSubnetGroups_nextToken - An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
DescribeSubnetGroups, describeSubnetGroups_subnetGroupName - The name of the subnet group to return details for.
Request Lenses
describeSubnetGroups_maxResults :: Lens' DescribeSubnetGroups (Maybe Int) Source #
The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.
describeSubnetGroups_nextToken :: Lens' DescribeSubnetGroups (Maybe Text) Source #
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
describeSubnetGroups_subnetGroupName :: Lens' DescribeSubnetGroups (Maybe Text) Source #
The name of the subnet group to return details for.
Destructuring the Response
data DescribeSubnetGroupsResponse Source #
See: newDescribeSubnetGroupsResponse smart constructor.
Constructors
| DescribeSubnetGroupsResponse' | |
Fields
| |
Instances
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:
DescribeSubnetGroups, describeSubnetGroupsResponse_nextToken - An optional argument to pass in case the total number of records exceeds
the value of MaxResults. If nextToken is returned, there are more
results available. The value of nextToken is a unique pagination token
for each page. Make the call again using the returned token to retrieve
the next page. Keep all other arguments unchanged.
$sel:subnetGroups:DescribeSubnetGroupsResponse', describeSubnetGroupsResponse_subnetGroups - A list of subnet groups. Each element in the list contains detailed
information about one group.
$sel:httpStatus:DescribeSubnetGroupsResponse', describeSubnetGroupsResponse_httpStatus - The response's http status code.
Response Lenses
describeSubnetGroupsResponse_nextToken :: Lens' DescribeSubnetGroupsResponse (Maybe Text) Source #
An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.
describeSubnetGroupsResponse_subnetGroups :: Lens' DescribeSubnetGroupsResponse (Maybe [SubnetGroup]) Source #
A list of subnet groups. Each element in the list contains detailed information about one group.
describeSubnetGroupsResponse_httpStatus :: Lens' DescribeSubnetGroupsResponse Int Source #
The response's http status code.