Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeRuntimeVersions

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

Request Syntax


POST /runtime-versions HTTP/1.1
Content-type: application/json

{
   "MaxResults": number,
   "NextToken": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

MaxResults

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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

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.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 252.

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "NextToken": "string",
   "RuntimeVersions": [ 
      { 
         "DeprecationDate": number,
         "Description": "string",
         "ReleaseDate": number,
         "VersionName": "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.

NextToken

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.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 252.

RuntimeVersions

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

Type: Array of RuntimeVersion objects

Errors

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

InternalServerException

An unknown internal error occurred.

HTTP Status Code: 500

ValidationException

A parameter could not be validated.

HTTP Status Code: 400