ARCRegionswitch / Client / list_route53_health_checks

list_route53_health_checks¶

ARCRegionswitch.Client.list_route53_health_checks(**kwargs)¶

List the Amazon Route 53 health checks.

Request Syntax

response = client.list_route53_health_checks(
    arn='string',
    hostedZoneId='string',
    recordName='string',
    maxResults=123,
    nextToken='string'
)

Parameters:

arn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the Amazon Route 53 health check request.
hostedZoneId (string) – The hosted zone ID for the health checks.
recordName (string) – The record name for the health checks.
maxResults (integer) – The number of objects that you want to return with this call.
nextToken (string) – 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.

Return type:

dict

Returns:

Response Syntax

{
    'healthChecks': [
        {
            'hostedZoneId': 'string',
            'recordName': 'string',
            'healthCheckId': 'string',
            'region': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- healthChecks (list) –
  
  List of the health checks requested.
  - (dict) –
    
    The Amazon Route 53 health check.
    - hostedZoneId (string) –
      
      The Amazon Route 53 health check hosted zone ID.
    - recordName (string) –
      
      The Amazon Route 53 record name.
    - healthCheckId (string) –
      
      The Amazon Route 53 health check ID.
    - region (string) –
      
      The Amazon Route 53 Region.
- nextToken (string) –
  
  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.

Exceptions

ARCRegionswitch.Client.exceptions.ResourceNotFoundException
ARCRegionswitch.Client.exceptions.AccessDeniedException
ARCRegionswitch.Client.exceptions.InternalServerException