Returns a list of DBParameterGroup descriptions. If a DBParameterGroupName is specified, the
list will contain only the description of the specified DBParameterGroup.
Access
Parameters
Parameter |
Type |
Required |
Description |
$opt
|
array
|
Optional
|
An associative array of parameters that can have the following keys:
DBParameterGroupName - string - Optional - The name of a specific DB Parameter Group to return details for. Constraints:- Must be 1 to 255 alphanumeric characters
- First character must be a letter
- Cannot end with a hyphen or contain two consecutive hyphens
MaxRecords - integer - Optional - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so that the remaining results may be retrieved. Default: 100 Constraints: minimum 20, maximum 100Marker - string - Optional - An optional pagination token provided by a previous DescribeDBParameterGroups 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 the database parameter groups.
// Instantiate the class
$rds = new AmazonRDS();
$response = $rds->describe_db_parameter_groups(array(
'DBParameterGroupName' => 'myParamGroup'
));
// Success?
var_dump($response->isOK());
Result:
bool(true)
Related Methods
Source