Skip to content

list_route53_health_checks_in_region

list_route53_health_checks_in_region(
    arn: PlanArn,
    *,
    config_overrides: Optional[ARCRegionswitchClientConfig] = None,
    hosted_zone_id: Optional[Route53HostedZoneId] = None,
    record_name: Optional[Route53RecordName] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[NextToken] = None,
) -> ListRoute53HealthChecksInRegionResponse

List the Amazon Route 53 health checks in a specific Amazon Web Services Region.

Parameters:

  • arn (PlanArn) –

    The Amazon Resource Name (ARN) of the Arc Region Switch Plan.

  • hosted_zone_id (Optional[Route53HostedZoneId], default: None ) –

    The hosted zone ID for the health checks.

  • record_name (Optional[Route53RecordName], default: None ) –

    The record name for the health checks.

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

    The maximum number of results to return in the response.

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

    Specifies that you want to receive the next page of results. Valid only if you received a nextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's nextToken response to request the next page of results.

Raises:

Examples:

Example ListRoute53HealthChecksInRegion

>>> client.list_route53_health_checks_in_region(arn='arn:aws:arc-region-switch::123456789012:plan/example:000000', hosted_zone_id='Z0123456789ABCDEFGHI', record_name='my.record.name', max_results=10, next_token='eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAxfQ')
Source code in docs_src/capo_arc_region_switch/_services/arc_regionswitch.py
def list_route53_health_checks_in_region(
    self,
    arn: "capo_arc_region_switch.types.plan_arn.PlanArn",
    *,
    config_overrides: Optional[ARCRegionswitchClientConfig] = None,
    hosted_zone_id: Optional[
        "capo_arc_region_switch.types.route53_hosted_zone_id.Route53HostedZoneId"
    ] = None,
    record_name: Optional[
        "capo_arc_region_switch.types.route53_record_name.Route53RecordName"
    ] = None,
    max_results: Optional[
        "capo_arc_region_switch.types.max_results.MaxResults"
    ] = None,
    next_token: Optional[
        "capo_arc_region_switch.types.next_token.NextToken"
    ] = None,
) -> "capo_arc_region_switch.types.list_route53_health_checks_in_region_response.ListRoute53HealthChecksInRegionResponse":
    """<p>List the Amazon Route 53 health checks in a specific Amazon Web Services Region.</p>

    Args:
        arn: <p>The Amazon Resource Name (ARN) of the Arc Region Switch Plan.</p>
        hosted_zone_id: <p>The hosted zone ID for the health checks.</p>
        record_name: <p>The record name for the health checks.</p>
        max_results: <p>The maximum number of results to return in the response.</p>
        next_token: <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>nextToken</code> response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's <code>nextToken</code> response to request the next page of results.</p>

    Raises:
        capo_arc_region_switch.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p> <p>HTTP Status Code: 403</p>
        capo_arc_region_switch.errors.illegal_argument_exception.IllegalArgumentException: <p>The request processing has an invalid argument.</p>
        capo_arc_region_switch.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception, or failure.</p> <p>HTTP Status Code: 500</p>
        capo_arc_region_switch.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p> <p>HTTP Status Code: 404</p>
        capo_arc_region_switch.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Example ListRoute53HealthChecksInRegion

        >>> client.list_route53_health_checks_in_region(arn='arn:aws:arc-region-switch::123456789012:plan/example:000000', hosted_zone_id='Z0123456789ABCDEFGHI', record_name='my.record.name', max_results=10, next_token='eyJNYXJrZXIiOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiOiAxfQ')
    """

    def _handler(
        req: "OperationRequest[capo_arc_region_switch.types.list_route53_health_checks_in_region_request.ListRoute53HealthChecksInRegionRequest]",
    ) -> OperationResponse[
        "capo_arc_region_switch.types.list_route53_health_checks_in_region_response.ListRoute53HealthChecksInRegionResponse"
    ]:
        import capo_arc_region_switch._operations.arc_region_switch.list_route53_health_checks_in_region

        output, http_response = (
            capo_arc_region_switch._operations.arc_region_switch.list_route53_health_checks_in_region.list_route53_health_checks_in_region(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListRoute53HealthChecksInRegion")
    )
    input_: capo_arc_region_switch.types.list_route53_health_checks_in_region_request.ListRoute53HealthChecksInRegionRequest = {
        "arn": arn
    }
    if hosted_zone_id is not None:
        input_["hosted_zone_id"] = hosted_zone_id
    if record_name is not None:
        input_["record_name"] = record_name
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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