describe_db_cluster_parameters ¶

def describe_db_cluster_parameters(
    self,
    *,
    config_overrides: Optional[DocDBClientConfig] = None,
    db_cluster_parameter_group_name: Optional[
        "capo_docdb.types.string.String"
    ] = None,
    source: Optional["capo_docdb.types.string.String"] = None,
    filters: Optional["capo_docdb.types.filter_list.FilterList"] = None,
    max_records: Optional[
        "capo_docdb.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_docdb.types.string.String"] = None,
) -> "capo_docdb.types.db_cluster_parameter_group_details.DBClusterParameterGroupDetails":
    """<p>Returns the detailed parameter list for a particular cluster parameter group.</p>

    Args:
        db_cluster_parameter_group_name: <p>The name of a specific cluster parameter group to return parameter details for.</p> <p>Constraints:</p> <ul> <li> <p>If provided, must match the name of an existing <code>DBClusterParameterGroup</code>.</p> </li> </ul>
        source: <p> A value that indicates to return only parameters for a specific source. Parameter sources can be <code>engine</code>, <code>service</code>, or <code>customer</code>. </p>
        filters: <p>This parameter is not 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 (marker) is included in the response so that the remaining results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>
        marker: <p>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 <code>MaxRecords</code>.</p>

    Raises:
        capo_docdb.errors.db_parameter_group_not_found_fault.DBParameterGroupNotFoundFault: <p> <code>DBParameterGroupName</code> doesn't refer to an existing parameter group. </p>
        capo_docdb.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_docdb.types.describe_db_cluster_parameters_message.DescribeDBClusterParametersMessage]",
    ) -> OperationResponse[
        "capo_docdb.types.db_cluster_parameter_group_details.DBClusterParameterGroupDetails"
    ]:
        import capo_docdb._operations.amazon_rd_sv19.describe_db_cluster_parameters

        output, http_response = (
            capo_docdb._operations.amazon_rd_sv19.describe_db_cluster_parameters.describe_db_cluster_parameters(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDBClusterParameters")
    )
    input_: capo_docdb.types.describe_db_cluster_parameters_message.DescribeDBClusterParametersMessage = {}
    if db_cluster_parameter_group_name is not None:
        input_["db_cluster_parameter_group_name"] = db_cluster_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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output