Skip to content

describe_runtime_versions

describe_runtime_versions(
    *,
    config_overrides: Optional[syntheticsClientConfig] = None,
    next_token: Optional[Token] = None,
    max_results: Optional[MaxSize100] = None,
) -> DescribeRuntimeVersionsResponse

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

Parameters:

  • next_token (Optional[Token], default: None ) –

    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.

  • max_results (Optional[MaxSize100], default: None ) –

    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.

Raises:

Source code in docs_src/capo_synthetics/_services/synthetics.py
def describe_runtime_versions(
    self,
    *,
    config_overrides: Optional[syntheticsClientConfig] = None,
    next_token: Optional["capo_synthetics.types.token.Token"] = None,
    max_results: Optional["capo_synthetics.types.max_size100.MaxSize100"] = None,
) -> "capo_synthetics.types.describe_runtime_versions_response.DescribeRuntimeVersionsResponse":
    """<p>Returns a list of Synthetics canary runtime versions. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Synthetics_Canaries_Library.html"> Canary Runtime Versions</a>.</p>

    Args:
        next_token: <p>A token that indicates that there is more data available. You can use this token in a subsequent <code>DescribeRuntimeVersions</code> operation to retrieve the next set of results.</p>
        max_results: <p>Specify this parameter to limit how many runs are returned each time you use the <code>DescribeRuntimeVersions</code> operation. If you omit this parameter, the default of 100 is used.</p>

    Raises:
        capo_synthetics.errors.internal_server_exception.InternalServerException: <p>An unknown internal error occurred.</p>
        capo_synthetics.errors.validation_exception.ValidationException: <p>A parameter could not be validated.</p>
        capo_synthetics.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_synthetics.types.describe_runtime_versions_request.DescribeRuntimeVersionsRequest]",
    ) -> OperationResponse[
        "capo_synthetics.types.describe_runtime_versions_response.DescribeRuntimeVersionsResponse"
    ]:
        import capo_synthetics._operations.synthetics.describe_runtime_versions

        output, http_response = (
            capo_synthetics._operations.synthetics.describe_runtime_versions.describe_runtime_versions(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeRuntimeVersions")
    )
    input_: capo_synthetics.types.describe_runtime_versions_request.DescribeRuntimeVersionsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output