Returns a list of the available engines.
See also: AWS API Documentation
describe-db-engine-versions
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: DBEngineVersions
describe-db-engine-versions
[--engine <value>]
[--engine-version <value>]
[--db-parameter-group-family <value>]
[--filters <value>]
[--default-only | --no-default-only]
[--list-supported-character-sets | --no-list-supported-character-sets]
[--list-supported-timezones | --no-list-supported-timezones]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--engine
(string)
The database engine to return.
--engine-version
(string)
The database engine version to return.
Example:
3.6.0
--db-parameter-group-family
(string)
The name of a specific parameter group family to return details for.
Constraints:
If provided, must match an existing
DBParameterGroupFamily
.
--filters
(list)
This parameter is not currently supported.
(structure)
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
Name -> (string)
The name of the filter. Filter names are case sensitive.
Values -> (list)
One or more filter values. Filter values are case sensitive.
(string)
Shorthand Syntax:
Name=string,Values=string,string ...
JSON Syntax:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--default-only
| --no-default-only
(boolean)
Indicates that only the default version of the specified engine or engine and major version combination is returned.
--list-supported-character-sets
| --no-list-supported-character-sets
(boolean)
If this parameter is specified and the requested engine supports the
CharacterSetName
parameter forCreateDBInstance
, the response includes a list of supported character sets for each engine version.
--list-supported-timezones
| --no-list-supported-timezones
(boolean)
If this parameter is specified and the requested engine supports the
TimeZone
parameter forCreateDBInstance
, the response includes a list of supported time zones for each engine version.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination.
--output
(string)
The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb://
will always be treated as binary and use the file contents directly regardless of the cli-binary-format
setting. When using file://
the file contents will need to properly formatted for the configured cli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)
Disable cli pager for output.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)
Disable automatically prompt for CLI input parameters.
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To list available Amazon DocumentDB engine versions
The following describe-db-engine-versions
example lists all available Amazon DocumentDB engine versions.
aws docdb describe-db-engine-versions \
--engine docdb
Output:
{
"DBEngineVersions": [
{
"DBEngineVersionDescription": "DocDB version 1.0.200837",
"DBParameterGroupFamily": "docdb3.6",
"EngineVersion": "3.6.0",
"ValidUpgradeTarget": [],
"DBEngineDescription": "Amazon DocumentDB (with MongoDB compatibility)",
"SupportsLogExportsToCloudwatchLogs": true,
"Engine": "docdb",
"ExportableLogTypes": [
"audit"
]
}
]
}
For more information, see DescribeDBEngineVersions in the Amazon DocumentDB Developer Guide.
Marker -> (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
.
DBEngineVersions -> (list)
Detailed information about one or more engine versions.
(structure)
Detailed information about an engine version.
Engine -> (string)
The name of the database engine.
EngineVersion -> (string)
The version number of the database engine.
DBParameterGroupFamily -> (string)
The name of the parameter group family for the database engine.
DBEngineDescription -> (string)
The description of the database engine.
DBEngineVersionDescription -> (string)
The description of the database engine version.
ValidUpgradeTarget -> (list)
A list of engine versions that this database engine version can be upgraded to.
(structure)
The version of the database engine that an instance can be upgraded to.
Engine -> (string)
The name of the upgrade target database engine.
EngineVersion -> (string)
The version number of the upgrade target database engine.
Description -> (string)
The version of the database engine that an instance can be upgraded to.
AutoUpgrade -> (boolean)
A value that indicates whether the target version is applied to any source DB instances that have
AutoMinorVersionUpgrade
set totrue
.IsMajorVersionUpgrade -> (boolean)
A value that indicates whether a database engine is upgraded to a major version.
ExportableLogTypes -> (list)
The types of logs that the database engine has available for export to Amazon CloudWatch Logs.
(string)
SupportsLogExportsToCloudwatchLogs -> (boolean)
A value that indicates whether the engine version supports exporting the log types specified by
ExportableLogTypes
to CloudWatch Logs.