describe_db_parameters async ¶

async def describe_db_parameters(
    self,
    *,
    config_overrides: Optional[AsyncRDSClientConfig] = None,
    db_parameter_group_name: Optional["capo_rds.types.string.String"] = None,
    source: 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_parameter_group_details.DBParameterGroupDetails":
    """<p>Returns the detailed parameter list for a particular DB parameter group.</p>

    Args:
        db_parameter_group_name: <p>The name of a specific DB parameter group to return details for.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match the name of an existing DBParameterGroup.</p> </li> </ul>
        source: <p>The parameter types to return.</p> <p>Default: All parameter types returned</p> <p>Valid Values: <code>user | system | engine-default</code> </p>
        filters: <p>A filter that specifies one or more DB parameters to describe.</p> <p>The only supported filter is <code>parameter-name</code>. The results list only includes information about the DB parameters with these names.</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 that 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>DescribeDBParameters</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 the parameters in a DB parameter group
        The following example retrieves the details of the specified DB parameter group.

        >>> await client.describe_db_parameters(db_parameter_group_name='mydbpg')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_rds.types.describe_db_parameters_message.DescribeDBParametersMessage]",
    ) -> AsyncOperationResponse[
        "capo_rds.types.db_parameter_group_details.DBParameterGroupDetails"
    ]:
        import capo_rds._operations.amazon_rd_sv19.describe_db_parameters

        (
            output,
            http_response,
        ) = await capo_rds._operations.amazon_rd_sv19.describe_db_parameters.async_describe_db_parameters(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDBParameters")
    )
    input_: capo_rds.types.describe_db_parameters_message.DescribeDBParametersMessage = {}
    if db_parameter_group_name is not None:
        input_["db_parameter_group_name"] = db_parameter_group_name
    if source is not None:
        input_["source"] = source
    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