Returns information about reserved Cache Nodes for this account, or about a specified reserved
Cache Node.
Access
Parameters
Parameter |
Type |
Required |
Description |
$opt
|
array
|
Optional
|
An associative array of parameters that can have the following keys:
ReservedCacheNodeId - string - Optional - The reserved Cache Node identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.ReservedCacheNodesOfferingId - string - Optional - The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.CacheNodeType - string - Optional - The Cache Node type filter value. Specify this parameter to show only those reservations matching the specified Cache Nodes type.Duration - string - Optional - The duration filter value, specified in years or seconds. Specify this parameter to show only reservations for this duration. Valid Values: 1 | 3 | 31536000 | 94608000 ProductDescription - string - Optional - The product description filter value. Specify this parameter to show only those reservations matching the specified product description.OfferingType - string - Optional - The offering type filter value. Specify this parameter to show only the available offerings matching the specified offering type. Valid Values: "Light Utilization" | "Medium Utilization" | "Heavy Utilization" MaxRecords - integer - Optional - The maximum number of records to include in the response. If more than the MaxRecords value is available, a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: minimum 20, maximum 100Marker - string - Optional - The marker provided in the previous request. If this parameter is specified, the response includes records beyond the marker only, up to MaxRecords .curlopts - array - Optional - A set of values to pass directly into curl_setopt() , where the key is a pre-defined CURLOPT_* constant.returnCurlHandle - boolean - Optional - A private toggle specifying that the cURL handle be returned rather than actually completing the request. This toggle is useful for manually managed batch requests. |
Returns
Examples
Describe reserved cache nodes
$elasticache = new AmazonElastiCache();
$response = $elasticache->describe_reserved_cache_nodes();
var_dump($response->isOK());
Result:
bool(true)
Source