describe_runtime_versions

Synthetics.Client.describe_runtime_versions(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.describe_runtime_versions(
    NextToken='string',
    MaxResults=123
)
Parameters
  • NextToken (string) -- 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.
  • MaxResults (integer) -- 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.
Return type

dict

Returns

Response Syntax

{
    'RuntimeVersions': [
        {
            'VersionName': 'string',
            'Description': 'string',
            'ReleaseDate': datetime(2015, 1, 1),
            'DeprecationDate': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) --

    • RuntimeVersions (list) --

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

      • (dict) --

        This structure contains information about one canary runtime version. For more information about runtime versions, see Canary Runtime Versions.

        • VersionName (string) --

          The name of the runtime version. For a list of valid runtime versions, see Canary Runtime Versions.

        • Description (string) --

          A description of the runtime version, created by Amazon.

        • ReleaseDate (datetime) --

          The date that the runtime version was released.

        • DeprecationDate (datetime) --

          If this runtime version is deprecated, this value is the date of deprecation.

    • NextToken (string) --

      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.

Exceptions

  • Synthetics.Client.exceptions.InternalServerException
  • Synthetics.Client.exceptions.ValidationException