DescribeEngineVersionsCommand

Suggest an Edit

Returns a list of the available Redis OSS engine versions.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { MemoryDBClient, DescribeEngineVersionsCommand } from "@aws-sdk/client-memorydb"; // ES Modules import
// const { MemoryDBClient, DescribeEngineVersionsCommand } = require("@aws-sdk/client-memorydb"); // CommonJS import
const client = new MemoryDBClient(config);
const input = { // DescribeEngineVersionsRequest
  Engine: "STRING_VALUE",
  EngineVersion: "STRING_VALUE",
  ParameterGroupFamily: "STRING_VALUE",
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
  DefaultOnly: true || false,
};
const command = new DescribeEngineVersionsCommand(input);
const response = await client.send(command);
// { // DescribeEngineVersionsResponse
//   NextToken: "STRING_VALUE",
//   EngineVersions: [ // EngineVersionInfoList
//     { // EngineVersionInfo
//       Engine: "STRING_VALUE",
//       EngineVersion: "STRING_VALUE",
//       EnginePatchVersion: "STRING_VALUE",
//       ParameterGroupFamily: "STRING_VALUE",
//     },
//   ],
// };

DescribeEngineVersionsCommand Input

See DescribeEngineVersionsCommandInput for more details

Parameter
Type
Description
DefaultOnly
boolean | undefined

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

Engine
string | undefined

The name of the engine for which to list available versions.

EngineVersion
string | undefined

The Redis OSS engine version

MaxResults
number | undefined

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.

NextToken
string | undefined

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.

ParameterGroupFamily
string | undefined

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

DescribeEngineVersionsCommand Output

See DescribeEngineVersionsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
EngineVersions
EngineVersionInfo[] | undefined

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

NextToken
string | undefined

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.

Throws

Name
Fault
Details
InvalidParameterCombinationException
client

InvalidParameterValueException
client

ServiceLinkedRoleNotFoundFault
client

MemoryDBServiceException
Base exception class for all service exceptions from MemoryDB service.