describeSubnetGroups method

Future<DescribeSubnetGroupsResponse> describeSubnetGroups({
  1. int? maxResults,
  2. String? nextToken,
  3. List<String>? subnetGroupNames,
})

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

May throw SubnetGroupNotFoundFault. May throw ServiceLinkedRoleNotFoundFault.

Parameter 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.

Parameter 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.

Parameter subnetGroupNames : The name of the subnet group.

Implementation

Future<DescribeSubnetGroupsResponse> describeSubnetGroups({
  int? maxResults,
  String? nextToken,
  List<String>? subnetGroupNames,
}) async {
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'AmazonDAXV3.DescribeSubnetGroups'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (maxResults != null) 'MaxResults': maxResults,
      if (nextToken != null) 'NextToken': nextToken,
      if (subnetGroupNames != null) 'SubnetGroupNames': subnetGroupNames,
    },
  );

  return DescribeSubnetGroupsResponse.fromJson(jsonResponse.body);
}