Returns information about reserved DB Instances for this account, or about a specified reserved
DB Instance.
Access
Parameters
Parameter |
Type |
Required |
Description |
$opt
|
array
|
Optional
|
An associative array of parameters that can have the following keys:
ReservedDBInstanceId - string - Optional - The reserved DB Instance identifier filter value. Specify this parameter to show only the reservation that matches the specified reservation ID.ReservedDBInstancesOfferingId - string - Optional - The offering identifier filter value. Specify this parameter to show only purchased reservations matching the specified offering identifier.DBInstanceClass - string - Optional - The DB Instance class filter value. Specify this parameter to show only those reservations matching the specified DB Instances class.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" MultiAZ - boolean - Optional - The Multi-AZ filter value. Specify this parameter to show only those reservations matching the specified Multi-AZ parameter.MaxRecords - integer - Optional - The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved. Default: 100 Constraints: minimum 20, maximum 100Marker - string - Optional - An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by 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 database instances.
// Instantiate the class
$rds = new AmazonRDS();
$response = $rds->describe_reserved_db_instances();
// Success?
var_dump($response->isOK());
Result:
bool(true)
Related Methods
Source