DescribeRuntimeVersionsCommand

Suggest an Edit

Returns a list of Synthetics canary runtime versions. For more information, see Canary Runtime Versions .

Example Syntax

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

import { SyntheticsClient, DescribeRuntimeVersionsCommand } from "@aws-sdk/client-synthetics"; // ES Modules import
// const { SyntheticsClient, DescribeRuntimeVersionsCommand } = require("@aws-sdk/client-synthetics"); // CommonJS import
const client = new SyntheticsClient(config);
const input = { // DescribeRuntimeVersionsRequest
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new DescribeRuntimeVersionsCommand(input);
const response = await client.send(command);
// { // DescribeRuntimeVersionsResponse
//   RuntimeVersions: [ // RuntimeVersionList
//     { // RuntimeVersion
//       VersionName: "STRING_VALUE",
//       Description: "STRING_VALUE",
//       ReleaseDate: new Date("TIMESTAMP"),
//       DeprecationDate: new Date("TIMESTAMP"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

DescribeRuntimeVersionsCommand Input

See DescribeRuntimeVersionsCommandInput for more details

Parameter
Type
Description
MaxResults
number | undefined

Specify this parameter to limit how many runs are returned each time you use the DescribeRuntimeVersions operation. If you omit this parameter, the default of 100 is used.

NextToken
string | undefined

A token that indicates that there is more data available. You can use this token in a subsequent DescribeRuntimeVersions operation to retrieve the next set of results.

DescribeRuntimeVersionsCommand Output

See DescribeRuntimeVersionsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
NextToken
string | undefined

A token that indicates that there is more data available. You can use this token in a subsequent DescribeRuntimeVersions operation to retrieve the next set of results.

RuntimeVersions
RuntimeVersion[] | undefined

An array of objects that display the details about each Synthetics canary runtime version.

Throws

Name
Fault
Details
InternalServerException
server

An unknown internal error occurred.

ValidationException
client

A parameter could not be validated.

SyntheticsServiceException
Base exception class for all service exceptions from Synthetics service.