describe_orderable_db_instance_options ¶

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

    Args:
        engine: <p>The name of the database engine to describe DB instance options for.</p> <p>Valid Values:</p> <ul> <li> <p> <code>aurora-mysql</code> </p> </li> <li> <p> <code>aurora-postgresql</code> </p> </li> <li> <p> <code>custom-oracle-ee</code> </p> </li> <li> <p> <code>custom-oracle-ee-cdb</code> </p> </li> <li> <p> <code>custom-oracle-se2</code> </p> </li> <li> <p> <code>custom-oracle-se2-cdb</code> </p> </li> <li> <p> <code>db2-ae</code> </p> </li> <li> <p> <code>db2-ce</code> </p> </li> <li> <p> <code>db2-se</code> </p> </li> <li> <p> <code>mariadb</code> </p> </li> <li> <p> <code>mysql</code> </p> </li> <li> <p> <code>oracle-ee</code> </p> </li> <li> <p> <code>oracle-ee-cdb</code> </p> </li> <li> <p> <code>oracle-se2</code> </p> </li> <li> <p> <code>oracle-se2-cdb</code> </p> </li> <li> <p> <code>postgres</code> </p> </li> <li> <p> <code>sqlserver-ee</code> </p> </li> <li> <p> <code>sqlserver-se</code> </p> </li> <li> <p> <code>sqlserver-ex</code> </p> </li> <li> <p> <code>sqlserver-web</code> </p> </li> </ul>
        engine_version: <p>A filter to include only the available options for the specified engine version.</p>
        db_instance_class: <p>A filter to include only the available options for the specified DB instance class.</p>
        license_model: <p>A filter to include only the available options for the specified license model.</p> <p>RDS Custom supports only the BYOL licensing model.</p>
        availability_zone_group: <p>The Availability Zone group associated with a Local Zone. Specify this parameter to retrieve available options for the Local Zones in the group.</p> <p>Omit this parameter to show the available options in the specified Amazon Web Services Region.</p> <p>This setting doesn't apply to RDS Custom DB instances.</p>
        vpc: <p>Specifies whether to show only VPC or non-VPC offerings. RDS Custom supports only VPC offerings.</p> <p>RDS Custom supports only VPC offerings. If you describe non-VPC offerings for RDS Custom, the output shows VPC offerings.</p>
        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 that you can retrieve the remaining results.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 1000.</p>
        marker: <p>An optional pagination token provided by a previous DescribeOrderableDBInstanceOptions 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.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To describe orderable DB instance options
        The following example retrieves details about the orderable options for a DB instances running the MySQL DB engine.

        >>> client.describe_orderable_db_instance_options(engine='mysql')
    """

    def _handler(
        req: "OperationRequest[capo_rds.types.describe_orderable_db_instance_options_message.DescribeOrderableDBInstanceOptionsMessage]",
    ) -> OperationResponse[
        "capo_rds.types.orderable_db_instance_options_message.OrderableDBInstanceOptionsMessage"
    ]:
        import capo_rds._operations.amazon_rd_sv19.describe_orderable_db_instance_options

        output, http_response = (
            capo_rds._operations.amazon_rd_sv19.describe_orderable_db_instance_options.describe_orderable_db_instance_options(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeOrderableDBInstanceOptions")
    )
    input_: capo_rds.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 availability_zone_group is not None:
        input_["availability_zone_group"] = availability_zone_group
    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 = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output