describeClusterSecurityGroups method

Future<ClusterSecurityGroupMessage> describeClusterSecurityGroups({ String? clusterSecurityGroupName, String? marker, int? maxRecords, List<String>? tagKeys, List<String>? tagValues, })

Returns information about Amazon Redshift security groups. If the name of a security group is specified, the response will contain only information about only that security group.

For information about managing security groups, go to Amazon Redshift Cluster Security Groups in the Amazon Redshift Cluster Management Guide.

If you specify both tag keys and tag values in the same request, Amazon Redshift returns all security groups that match any combination of the specified keys and values. For example, if you have owner and environment for tag keys, and admin and test for tag values, all security groups that have any combination of those values are returned.

If both tag keys and values are omitted from the request, security groups are returned regardless of whether they have tag keys or values associated with them.

May throw ClusterSecurityGroupNotFoundFault. May throw InvalidTagFault.

Parameter clusterSecurityGroupName : The name of a cluster security group for which you are requesting details. You can specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.

Example: securitygroup1

Parameter marker : An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeClusterSecurityGroups request exceed the value specified in MaxRecords, AWS returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

Constraints: You can specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.

Parameter maxRecords : The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

Parameter tagKeys : A tag key or keys for which you want to return all matching cluster security groups that are associated with the specified key or keys. For example, suppose that you have security groups that are tagged with keys called owner and environment. If you specify both of these tag keys in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag keys associated with them.

Parameter tagValues : A tag value or values for which you want to return all matching cluster security groups that are associated with the specified tag value or values. For example, suppose that you have security groups that are tagged with values called admin and test. If you specify both of these tag values in the request, Amazon Redshift returns a response with the security groups that have either or both of these tag values associated with them.

Implementation

Future<ClusterSecurityGroupMessage> describeClusterSecurityGroups({
  String? clusterSecurityGroupName,
  String? marker,
  int? maxRecords,
  List<String>? tagKeys,
  List<String>? tagValues,
}) async {
  _s.validateStringLength(
    'clusterSecurityGroupName',
    clusterSecurityGroupName,
    0,
    2147483647,
  );
  _s.validateStringLength(
    'marker',
    marker,
    0,
    2147483647,
  );
  final $request = <String, dynamic>{};
  clusterSecurityGroupName
      ?.also((arg) => $request['ClusterSecurityGroupName'] = arg);
  marker?.also((arg) => $request['Marker'] = arg);
  maxRecords?.also((arg) => $request['MaxRecords'] = arg);
  tagKeys?.also((arg) => $request['TagKeys'] = arg);
  tagValues?.also((arg) => $request['TagValues'] = arg);
  final $result = await _protocol.send(
    $request,
    action: 'DescribeClusterSecurityGroups',
    version: '2012-12-01',
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    shape: shapes['DescribeClusterSecurityGroupsMessage'],
    shapes: shapes,
    resultWrapper: 'DescribeClusterSecurityGroupsResult',
  );
  return ClusterSecurityGroupMessage.fromXml($result);
}