describe_orderable_db_instance_options async ¶

async def describe_orderable_db_instance_options(
    self,
    *,
    config_overrides: Optional[AsyncDocDBClientConfig] = None,
    engine: Optional["capo_docdb.types.string.String"] = None,
    engine_version: Optional["capo_docdb.types.string.String"] = None,
    db_instance_class: Optional["capo_docdb.types.string.String"] = None,
    license_model: Optional["capo_docdb.types.string.String"] = None,
    vpc: Optional["capo_docdb.types.boolean_optional.BooleanOptional"] = 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.orderable_db_instance_options_message.OrderableDBInstanceOptionsMessage":
    """<p>Returns a list of orderable instance options for the specified engine.</p>

    Args:
        engine: <p>The name of the engine to retrieve instance options for.</p>
        engine_version: <p>The engine version filter value. Specify this parameter to show only the available offerings that match the specified engine version.</p>
        db_instance_class: <p>The instance class filter value. Specify this parameter to show only the available offerings that match the specified instance class.</p>
        license_model: <p>The license model filter value. Specify this parameter to show only the available offerings that match the specified license model.</p>
        vpc: <p>The virtual private cloud (VPC) filter value. Specify this parameter to show only the available VPC or non-VPC offerings.</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.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_docdb.types.describe_orderable_db_instance_options_message.DescribeOrderableDBInstanceOptionsMessage]",
    ) -> AsyncOperationResponse[
        "capo_docdb.types.orderable_db_instance_options_message.OrderableDBInstanceOptionsMessage"
    ]:
        import capo_docdb._operations.amazon_rd_sv19.describe_orderable_db_instance_options

        (
            output,
            http_response,
        ) = await capo_docdb._operations.amazon_rd_sv19.describe_orderable_db_instance_options.async_describe_orderable_db_instance_options(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeOrderableDBInstanceOptions")
    )
    input_: capo_docdb.types.describe_orderable_db_instance_options_message.DescribeOrderableDBInstanceOptionsMessage = {}
    if engine is not None:
        input_["engine"] = engine
    if engine_version is not None:
        input_["engine_version"] = engine_version
    if db_instance_class is not None:
        input_["db_instance_class"] = db_instance_class
    if license_model is not None:
        input_["license_model"] = license_model
    if vpc is not None:
        input_["vpc"] = vpc
    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