<a id="cli-aws-rds-describe-engine-default-parameters"></a>

# describe-engine-default-parameters

## Description

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

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/DescribeEngineDefaultParameters)

`describe-engine-default-parameters` 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: `EngineDefaults.Parameters`

## Synopsis

```
  describe-engine-default-parameters
--db-parameter-group-family <value>
[--filters <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--cli-input-json | --cli-input-yaml]
[--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]
[--cli-error-format <value>]
[--help]
```

## Options

`--db-parameter-group-family` (string) [required]

> The name of the DB parameter group family.

> Valid Values:

> * `aurora-mysql5.7`
> * `aurora-mysql8.0`
> * `aurora-postgresql10`
> * `aurora-postgresql11`
> * `aurora-postgresql12`
> * `aurora-postgresql13`
> * `aurora-postgresql14`
> * `custom-oracle-ee-19`
> * `custom-oracle-ee-cdb-19`
> * `db2-ae`
> * `db2-ce`
> * `db2-se`
> * `mariadb10.2`
> * `mariadb10.3`
> * `mariadb10.4`
> * `mariadb10.5`
> * `mariadb10.6`
> * `mysql5.7`
> * `mysql8.0`
> * `oracle-ee-19`
> * `oracle-ee-cdb-19`
> * `oracle-ee-cdb-21`
> * `oracle-se2-19`
> * `oracle-se2-cdb-19`
> * `oracle-se2-cdb-21`
> * `postgres10`
> * `postgres11`
> * `postgres12`
> * `postgres13`
> * `postgres14`
> * `sqlserver-ee-11.0`
> * `sqlserver-ee-12.0`
> * `sqlserver-ee-13.0`
> * `sqlserver-ee-14.0`
> * `sqlserver-ee-15.0`
> * `sqlserver-ex-11.0`
> * `sqlserver-ex-12.0`
> * `sqlserver-ex-13.0`
> * `sqlserver-ex-14.0`
> * `sqlserver-ex-15.0`
> * `sqlserver-se-11.0`
> * `sqlserver-se-12.0`
> * `sqlserver-se-13.0`
> * `sqlserver-se-14.0`
> * `sqlserver-se-15.0`
> * `sqlserver-web-11.0`
> * `sqlserver-web-12.0`
> * `sqlserver-web-13.0`
> * `sqlserver-web-14.0`
> * `sqlserver-web-15.0`

`--filters` (list)

> A filter that specifies one or more parameters to describe.

> The only supported filter is `parameter-name` . The results list only includes information about the parameters with these names.

> (structure)

> > A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

> > #### NOTE
> > Currently, wildcards are not supported in filters.

> > The following actions can be filtered:

> > * `DescribeDBCapacityReservations`
> > * `DescribeDBClusterBacktracks`
> > * `DescribeDBClusterEndpoints`
> > * `DescribeDBClusters`
> > * `DescribeDBInstances`
> > * `DescribeDBRecommendations`
> > * `DescribeDBShardGroups`
> > * `DescribePendingMaintenanceActions`

> > Name -> (string) [required]

> > > The name of the filter. Filter names are case-sensitive.

> > Values -> (list) [required]

> > > One or more filter values. Filter values are case-sensitive.

> > > (string)

Shorthand Syntax:

```
Name=string,Values=string,string ...
```

JSON Syntax:

```json
[
  {
    "Name": "string",
    "Values": ["string", ...]
  }
  ...
]
```

`--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](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) 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](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) 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 the `NextToken` value in the `starting-token` argument of a subsequent command. **Do not** use the `NextToken` response element directly outside of the AWS CLI.

> For usage examples, see [Pagination](https://docs.aws.amazon.com/cli/latest/userguide/pagination.html) in the *AWS Command Line Interface User Guide* .

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

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

## Global Options

`--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

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

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

`--help` (boolean)

Display help for the command/subcommand.

## Examples

#### NOTE
To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) 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](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS CLI User Guide* .

**To describe the default engine and system parameter information for the database engine**

The following `describe-engine-default-parameters` example retrieves details for the default engine and system parameter information for MySQL 5.7 DB instances.

```bash
aws rds describe-engine-default-parameters \
    --db-parameter-group-family mysql5.7
```

Output:

```json
{
    "EngineDefaults": {
        "Parameters": [
            {
                "ParameterName": "allow-suspicious-udfs",
                "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded",
                "Source": "engine-default",
                "ApplyType": "static",
                "DataType": "boolean",
                "AllowedValues": "0,1",
                "IsModifiable": false
            }
        ]
    }
}
```

For more information, see [Working with DB Parameter Groups](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_WorkingWithParamGroups.html) in the *Amazon RDS User Guide*.

## Output

EngineDefaults -> (structure)

> Contains the result of a successful invocation of the `DescribeEngineDefaultParameters` action.

> DBParameterGroupFamily -> (string)

> > Specifies the name of the DB parameter group family that the engine default parameters apply to.

> Marker -> (string)

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

> Parameters -> (list)

> > Contains a list of engine default parameters.

> > (structure)

> > > This data type is used as a request parameter in the `ModifyDBParameterGroup` and `ResetDBParameterGroup` actions.

> > > This data type is used as a response element in the `DescribeEngineDefaultParameters` and `DescribeDBParameters` actions.

> > > ParameterName -> (string)

> > > > The name of the parameter.

> > > ParameterValue -> (string)

> > > > The value of the parameter.

> > > Description -> (string)

> > > > Provides a description of the parameter.

> > > Source -> (string)

> > > > The source of the parameter value.

> > > ApplyType -> (string)

> > > > Specifies the engine specific parameters type.

> > > DataType -> (string)

> > > > Specifies the valid data type for the parameter.

> > > AllowedValues -> (string)

> > > > Specifies the valid range of values for the parameter.

> > > IsModifiable -> (boolean)

> > > > Indicates whether (`true` ) or not (`false` ) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

> > > MinimumEngineVersion -> (string)

> > > > The earliest engine version to which the parameter can apply.

> > > ApplyMethod -> (string)

> > > > Indicates when to apply parameter updates.

> > > > Possible values:

> > > > * `immediate`
> > > > * `pending-reboot`

> > > SupportedEngineModes -> (list)

> > > > The valid DB engine modes.

> > > > (string)