Returns a list of DBClusterParameterGroup descriptions. If a DBClusterParameterGroupName parameter is specified, the list will contain only the description of the specified DB cluster parameter group.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.
Parameters:
-
db_cluster_parameter_group_name
(Optional[String], default:
None
)
–
The name of a specific DB cluster parameter group to return details for.
Constraints:
-
filters
(Optional[FilterList], default:
None
)
–
This parameter isn't currently supported.
-
max_records
(Optional[IntegerOptional], default:
None
)
–
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 you can retrieve the remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
-
marker
(Optional[String], default:
None
)
–
An optional pagination token provided by a previous DescribeDBClusterParameterGroups request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
Raises:
Examples:
To describe DB cluster parameter groups
The following example retrieves details for your DB cluster parameter groups.
>>> await client.describe_db_cluster_parameter_groups()
Source code in docs_src/capo_rds/_services/async_rds.py
| async def describe_db_cluster_parameter_groups(
self,
*,
config_overrides: Optional[AsyncRDSClientConfig] = None,
db_cluster_parameter_group_name: Optional[
"capo_rds.types.string.String"
] = None,
filters: Optional["capo_rds.types.filter_list.FilterList"] = None,
max_records: Optional["capo_rds.types.integer_optional.IntegerOptional"] = None,
marker: Optional["capo_rds.types.string.String"] = None,
) -> "capo_rds.types.db_cluster_parameter_groups_message.DBClusterParameterGroupsMessage":
"""<p>Returns a list of <code>DBClusterParameterGroup</code> descriptions. If a <code>DBClusterParameterGroupName</code> parameter is specified, the list will contain only the description of the specified DB cluster parameter group.</p> <p>For more information on Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB cluster deployments</a> in the <i>Amazon RDS User Guide</i>.</p>
Args:
db_cluster_parameter_group_name: <p>The name of a specific DB cluster parameter group to return details for.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing DBClusterParameterGroup.</p> </li> </ul>
filters: <p>This parameter isn't currently supported.</p>
max_records: <p>The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so you can retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>
marker: <p>An optional pagination token provided by a previous <code>DescribeDBClusterParameterGroups</code> request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by <code>MaxRecords</code>.</p>
Raises:
capo_rds.errors.db_parameter_group_not_found_fault.DBParameterGroupNotFoundFault: <p> <code>DBParameterGroupName</code> doesn't refer to an existing DB parameter group.</p>
capo_rds.errors.UnknownServiceError: The service returned an error code this client does not model.
Examples:
To describe DB cluster parameter groups
The following example retrieves details for your DB cluster parameter groups.
>>> await client.describe_db_cluster_parameter_groups()
"""
async def _handler(
req: "AsyncOperationRequest[capo_rds.types.describe_db_cluster_parameter_groups_message.DescribeDBClusterParameterGroupsMessage]",
) -> AsyncOperationResponse[
"capo_rds.types.db_cluster_parameter_groups_message.DBClusterParameterGroupsMessage"
]:
import capo_rds._operations.amazon_rd_sv19.describe_db_cluster_parameter_groups
(
output,
http_response,
) = await capo_rds._operations.amazon_rd_sv19.describe_db_cluster_parameter_groups.async_describe_db_cluster_parameter_groups(
req.options, req.input
)
return AsyncOperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeDBClusterParameterGroups")
)
input_: capo_rds.types.describe_db_cluster_parameter_groups_message.DescribeDBClusterParameterGroupsMessage = {}
if db_cluster_parameter_group_name is not None:
input_["db_cluster_parameter_group_name"] = db_cluster_parameter_group_name
if filters is not None:
input_["filters"] = filters
if max_records is not None:
input_["max_records"] = max_records
if marker is not None:
input_["marker"] = marker
response = await aexecute_pipeline(
AsyncOperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
await response.response.aclose()
return response.output
|