Request Parameters Response Elements Errors Examples See Also

DescribeCacheSecurityGroups

Returns a list of cache security group descriptions. If a cache security group name is specified, the list contains only the description of that group. This applicable only when you have ElastiCache in Classic setup

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

CacheSecurityGroupName

The name of the cache security group to return details for.

Type: String

Required: No

Marker

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Type: String

Required: No

MaxRecords

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: minimum 20; maximum 100.

Type: Integer

Required: No

Response Elements

The following elements are returned by the service.

CacheSecurityGroups.CacheSecurityGroup.N

A list of cache security groups. Each element in the list contains detailed information about one group.

Type: Array of CacheSecurityGroup objects

Marker

Provides an identifier to allow retrieval of paginated results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

CacheSecurityGroupNotFound

The requested cache security group name does not refer to an existing cache security group.

HTTP Status Code: 404

InvalidParameterCombination

Two or more incompatible parameters were specified.

HTTP Status Code: 400

InvalidParameterValue

The value for a parameter is invalid.

HTTP Status Code: 400

Examples

DescribeCacheSecurityGroups

This example illustrates one usage of DescribeCacheSecurityGroups.

Sample Request


https://elasticache.us-west-2.amazonaws.com/
   ?Action=DescribeCacheSecurityGroups
   &MaxRecords=100
   &Version=2015-02-02
   &SignatureVersion=4
   &SignatureMethod=HmacSHA256
   &Timestamp=20150202T192317Z
   &X-Amz-Credential=<credential>

Sample Response



<DescribeCacheSecurityGroupsResponse xmlns="http://elasticache.amazonaws.com/doc/2015-02-02/">
  <DescribeCacheSecurityGroupsResult>
    <CacheSecurityGroups>
      <CacheSecurityGroup>
        <EC2SecurityGroups/>
        <CacheSecurityGroupName>default</CacheSecurityGroupName>
        <OwnerId>123456789012</OwnerId>
        <Description>default</Description>
      </CacheSecurityGroup>
      <CacheSecurityGroup>
        <EC2SecurityGroups/>
        <CacheSecurityGroupName>mycachesecuritygroup</CacheSecurityGroupName>
        <OwnerId>123456789012</OwnerId>
        <Description>My Security Group</Description>
      </CacheSecurityGroup>
    </CacheSecurityGroups>
  </DescribeCacheSecurityGroupsResult>
  <ResponseMetadata>
    <RequestId>a95360ae-b7fc-11e0-9326-b7275b9d4a6c</RequestId>
  </ResponseMetadata>
</DescribeCacheSecurityGroupsResponse>