describe_engine_default_parameters `async` ¶

describe_engine_default_parameters(
    *,
    config_overrides: Optional[AsyncNeptuneClientConfig] = None,
    db_parameter_group_family: Optional[String] = None,
    filters: Optional[FilterList] = None,
    max_records: Optional[IntegerOptional] = None,
    marker: Optional[String] = None,
) -> DescribeEngineDefaultParametersResult

Returns the default engine and system parameter information for the specified database engine.

Parameters:

db_parameter_group_family (Optional[String], default: None ) –

The name of the DB parameter group family.
filters (Optional[FilterList], default: None ) –

Not 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 that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.
marker (Optional[String], default: None ) –

An optional pagination token provided by a previous DescribeEngineDefaultParameters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_neptune/_services/async_neptune.py

async def describe_engine_default_parameters(
    self,
    *,
    config_overrides: Optional[AsyncNeptuneClientConfig] = None,
    db_parameter_group_family: Optional["capo_neptune.types.string.String"] = None,
    filters: Optional["capo_neptune.types.filter_list.FilterList"] = None,
    max_records: Optional[
        "capo_neptune.types.integer_optional.IntegerOptional"
    ] = None,
    marker: Optional["capo_neptune.types.string.String"] = None,
) -> "capo_neptune.types.describe_engine_default_parameters_result.DescribeEngineDefaultParametersResult":
    """<p>Returns the default engine and system parameter information for the specified database engine.</p>

    Args:
        db_parameter_group_family: <p>The name of the DB parameter group family.</p>
        filters: <p>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 called a 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 <code>DescribeEngineDefaultParameters</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_neptune.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_neptune.types.describe_engine_default_parameters_message.DescribeEngineDefaultParametersMessage]",
    ) -> AsyncOperationResponse[
        "capo_neptune.types.describe_engine_default_parameters_result.DescribeEngineDefaultParametersResult"
    ]:
        import capo_neptune._operations.amazon_rd_sv19.describe_engine_default_parameters

        (
            output,
            http_response,
        ) = await capo_neptune._operations.amazon_rd_sv19.describe_engine_default_parameters.async_describe_engine_default_parameters(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeEngineDefaultParameters")
    )
    input_: capo_neptune.types.describe_engine_default_parameters_message.DescribeEngineDefaultParametersMessage = {}
    if db_parameter_group_family is not None:
        input_["db_parameter_group_family"] = db_parameter_group_family
    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

describe_engine_default_parameters async ¶

describe_engine_default_parameters `async` ¶