Skip to content

DescribeDBEngineVersionsMessage

Source code in docs_src/capo_neptune/types/describe_db_engine_versions_message.py
class DescribeDBEngineVersionsMessage(TypedDict, closed=True):
    engine: NotRequired["capo_neptune.types.string.String"]
    """<p>The database engine to return.</p>"""
    engine_version: NotRequired["capo_neptune.types.string.String"]
    """<p>The database engine version to return.</p> <p>Example: <code>5.1.49</code> </p>"""
    db_parameter_group_family: NotRequired["capo_neptune.types.string.String"]
    """<p>The name of a specific DB parameter group family to return details for.</p> <p>Constraints:</p> <ul> <li> <p>If supplied, must match an existing DBParameterGroupFamily.</p> </li> </ul>"""
    filters: NotRequired["capo_neptune.types.filter_list.FilterList"]
    """<p>Not currently supported.</p>"""
    max_records: NotRequired["capo_neptune.types.integer_optional.IntegerOptional"]
    """<p> The maximum number of records to include in the response. If more than the <code>MaxRecords</code> value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.</p> <p>Default: 100</p> <p>Constraints: Minimum 20, maximum 100.</p>"""
    marker: NotRequired["capo_neptune.types.string.String"]
    """<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>"""
    default_only: NotRequired["capo_neptune.types.boolean.Boolean"]
    """<p>Indicates that only the default version of the specified engine or engine and major version combination is returned.</p>"""
    list_supported_character_sets: NotRequired[
        "capo_neptune.types.boolean_optional.BooleanOptional"
    ]
    """<p>If this parameter is specified and the requested engine supports the <code>CharacterSetName</code> parameter for <code>CreateDBInstance</code>, the response includes a list of supported character sets for each engine version.</p>"""
    list_supported_timezones: NotRequired[
        "capo_neptune.types.boolean_optional.BooleanOptional"
    ]
    """<p>If this parameter is specified and the requested engine supports the <code>TimeZone</code> parameter for <code>CreateDBInstance</code>, the response includes a list of supported time zones for each engine version.</p>"""

db_parameter_group_family instance-attribute

db_parameter_group_family: NotRequired[String]

The name of a specific DB parameter group family to return details for.

Constraints:

  • If supplied, must match an existing DBParameterGroupFamily.

default_only instance-attribute

default_only: NotRequired[Boolean]

Indicates that only the default version of the specified engine or engine and major version combination is returned.

engine instance-attribute

engine: NotRequired[String]

The database engine to return.

engine_version instance-attribute

engine_version: NotRequired[String]

The database engine version to return.

Example: 5.1.49

filters instance-attribute

filters: NotRequired[FilterList]

Not currently supported.

list_supported_character_sets instance-attribute

list_supported_character_sets: NotRequired[BooleanOptional]

If this parameter is specified and the requested engine supports the CharacterSetName parameter for CreateDBInstance, the response includes a list of supported character sets for each engine version.

list_supported_timezones instance-attribute

list_supported_timezones: NotRequired[BooleanOptional]

If this parameter is specified and the requested engine supports the TimeZone parameter for CreateDBInstance, the response includes a list of supported time zones for each engine version.

marker instance-attribute

marker: NotRequired[String]

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 MaxRecords.

max_records instance-attribute

max_records: NotRequired[IntegerOptional]

The maximum number of records to include in the response. If more than the MaxRecords value is available, a pagination token called a marker is included in the response so that the following results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.