describe_reserved_db_instances_offerings ( $opt )

Lists available reserved DB Instance offerings.

Access

public

Parameters

Parameter

Type

Required

Description

$opt

array

Optional

An associative array of parameters that can have the following keys:

  • ReservedDBInstancesOfferingId - string - Optional - The offering identifier filter value. Specify this parameter to show only the available offering that matches the specified reservation identifier. Example: 438012d3-4052-4cc7-b2e3-8d3372e0e706
  • DBInstanceClass - string - Optional - The DB Instance class filter value. Specify this parameter to show only the available offerings matching the specified DB Instance class.
  • Duration - string - Optional - 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 - Product description filter value. Specify this parameter to show only the available offerings 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 the available offerings 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 100
  • Marker - 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

Type

Description

CFResponse

A CFResponse object containing a parsed HTTP response.

Examples

Describe reserved database instance offerings.

// Instantiate the class
$rds = new AmazonRDS();

$response = $rds->describe_reserved_db_instances_offerings(array(
	'MultiAZ' => 'false'
));

// Success?
var_dump($response->isOK());
Result:
bool(true)

Related Methods

Source

Method defined in services/rds.class.php | Toggle source view (6 lines) | View on GitHub

public function describe_reserved_db_instances_offerings($opt = null)
{
    if (!$opt) $opt = array();
            
    return $this->authenticate('DescribeReservedDBInstancesOfferings', $opt);
}

Copyright © 2010–2013 Amazon Web Services, LLC


Feedback