DescribeEngineVersions - Amazon MemoryDB
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

DescribeEngineVersions

Returns a list of the available Redis engine versions.

Request Syntax

{ "DefaultOnly": boolean, "EngineVersion": "string", "MaxResults": number, "NextToken": "string", "ParameterGroupFamily": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DefaultOnly

If true, specifies that only the default version of the specified engine or engine and major version combination is to be returned.

Type: Boolean

Required: No

EngineVersion

The Redis engine version

Type: String

Required: No

MaxResults

The maximum number of records to include in the response. If more records exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Type: Integer

Required: No

NextToken

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Type: String

Required: No

ParameterGroupFamily

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

Type: String

Required: No

Response Syntax

{ "EngineVersions": [ { "EnginePatchVersion": "string", "EngineVersion": "string", "ParameterGroupFamily": "string" } ], "NextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EngineVersions

A list of engine version details. Each element in the list contains detailed information about one engine version.

Type: Array of EngineVersionInfo objects

NextToken

An optional argument to pass in case the total number of records exceeds the value of MaxResults. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterCombinationException

HTTP Status Code: 400

InvalidParameterValueException

HTTP Status Code: 400

ServiceLinkedRoleNotFoundFault

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: