DescribeClusterSecurityGroups
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.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- ClusterSecurityGroupName
-
The name of a cluster security group for which you are requesting details. You must specify either the Marker parameter or a ClusterSecurityGroupName parameter, but not both.
Example:
securitygroup1
Type: String
Length Constraints: Maximum length of 2147483647.
Required: No
- 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 theMarker
field of the response. You can retrieve the next set of response records by providing the returned marker value in theMarker
parameter and retrying the request.Constraints: You must specify either the ClusterSecurityGroupName parameter or the Marker parameter, but not both.
Type: String
Length Constraints: Maximum length of 2147483647.
Required: No
- 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 amarker
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.
Type: Integer
Required: No
- TagKeys.TagKey.N
-
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
andenvironment
. 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.Type: Array of strings
Length Constraints: Maximum length of 2147483647.
Required: No
- TagValues.TagValue.N
-
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
andtest
. 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.Type: Array of strings
Length Constraints: Maximum length of 2147483647.
Required: No
Response Elements
The following elements are returned by the service.
- ClusterSecurityGroups.ClusterSecurityGroup.N
-
A list of ClusterSecurityGroup instances.
Type: Array of ClusterSecurityGroup objects
- Marker
-
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the
Marker
parameter and retrying the command. If theMarker
field is empty, all response records have been retrieved for the request.Type: String
Length Constraints: Maximum length of 2147483647.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClusterSecurityGroupNotFound
-
The cluster security group name does not refer to an existing cluster security group.
HTTP Status Code: 404
- InvalidTagFault
-
The tag is invalid.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DescribeClusterSecurityGroups.
Sample Request
https://redshift.us-east-2.amazonaws.com/
?Action=DescribeClusterSecurityGroups
&Version=2012-12-01
&x-amz-algorithm=AWS4-HMAC-SHA256
&x-amz-credential=AKIAIOSFODNN7EXAMPLE/20130123/us-east-2/redshift/aws4_request
&x-amz-date=20130123T010237Z
&x-amz-signedheaders=content-type;host;x-amz-date
Sample Response
<DescribeClusterSecurityGroupsResponse xmlns="http://redshift.amazonaws.com/doc/2012-12-01/">
<DescribeClusterSecurityGroupsResult>
<ClusterSecurityGroups>
<ClusterSecurityGroup>
<EC2SecurityGroups/>
<IPRanges>
<IPRange>
<CIDRIP>0.0.0.0/0</CIDRIP>
<Status>authorized</Status>
</IPRange>
</IPRanges>
<Description>default</Description>
<ClusterSecurityGroupName>default</ClusterSecurityGroupName>
</ClusterSecurityGroup>
<ClusterSecurityGroup>
<EC2SecurityGroups/>
<IPRanges/>
<Description>my security group</Description>
<ClusterSecurityGroupName>securitygroup1</ClusterSecurityGroupName>
</ClusterSecurityGroup>
</ClusterSecurityGroups>
</DescribeClusterSecurityGroupsResult>
<ResponseMetadata>
<RequestId>947a8305-64f8-11e2-bec0-17624ad140dd</RequestId>
</ResponseMetadata>
</DescribeClusterSecurityGroupsResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: