list_health_checks ¶

list_health_checks(
    *,
    config_overrides: Optional[Route53ClientConfig] = None,
    marker: Optional[PageMarker] = None,
    max_items: Optional[int] = None,
) -> ListHealthChecksResponse

Retrieve a list of the health checks that are associated with the current Amazon Web Services account.

Parameters:

marker (Optional[PageMarker], default: None ) –

If the value of IsTruncated in the previous response was true, you have more health checks. To get another group, submit another ListHealthChecks request.

For the value of marker, specify the value of NextMarker from the previous response, which is the ID of the first health check that Amazon Route 53 will return if you submit another request.

If the value of IsTruncated in the previous response was false, there are no more health checks to get.
max_items (Optional[int], default: None ) –

The maximum number of health checks that you want ListHealthChecks to return in response to the current request. Amazon Route 53 returns a maximum of 1000 items. If you set MaxItems to a value greater than 1000, Route 53 returns only the first 1000 health checks.

Raises:

IncompatibleVersion –

The resource you're trying to access is unsupported on this Amazon Route 53 endpoint.
InvalidInput –

The input is not valid.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_route_53/_services/route53.py

def list_health_checks(
    self,
    *,
    config_overrides: Optional[Route53ClientConfig] = None,
    marker: Optional["capo_route_53.types.page_marker.PageMarker"] = None,
    max_items: Optional[int] = None,
) -> "capo_route_53.types.list_health_checks_response.ListHealthChecksResponse":
    """<p>Retrieve a list of the health checks that are associated with the current Amazon Web Services account. </p>

    Args:
        marker: <p>If the value of <code>IsTruncated</code> in the previous response was <code>true</code>, you have more health checks. To get another group, submit another <code>ListHealthChecks</code> request. </p> <p>For the value of <code>marker</code>, specify the value of <code>NextMarker</code> from the previous response, which is the ID of the first health check that Amazon Route 53 will return if you submit another request.</p> <p>If the value of <code>IsTruncated</code> in the previous response was <code>false</code>, there are no more health checks to get.</p>
        max_items: <p>The maximum number of health checks that you want <code>ListHealthChecks</code> to return in response to the current request. Amazon Route 53 returns a maximum of 1000 items. If you set <code>MaxItems</code> to a value greater than 1000, Route 53 returns only the first 1000 health checks. </p>

    Raises:
        capo_route_53.errors.incompatible_version.IncompatibleVersion: <p>The resource you're trying to access is unsupported on this Amazon Route 53 endpoint.</p>
        capo_route_53.errors.invalid_input.InvalidInput: <p>The input is not valid.</p>
        capo_route_53.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_route_53.types.list_health_checks_request.ListHealthChecksRequest]",
    ) -> OperationResponse[
        "capo_route_53.types.list_health_checks_response.ListHealthChecksResponse"
    ]:
        import capo_route_53._operations.aws_dns_v20130401.list_health_checks

        output, http_response = (
            capo_route_53._operations.aws_dns_v20130401.list_health_checks.list_health_checks(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListHealthChecks")
    )
    input_: capo_route_53.types.list_health_checks_request.ListHealthChecksRequest = {}
    if marker is not None:
        input_["marker"] = marker
    if max_items is not None:
        input_["max_items"] = max_items

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