:doc:`ARCRegionswitch <../../arc-region-switch>` / Paginator / ListRoute53HealthChecks

***********************
ListRoute53HealthChecks
***********************



.. py:class:: ARCRegionswitch.Paginator.ListRoute53HealthChecks

  ::

    
    paginator = client.get_paginator('list_route53_health_checks')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`ARCRegionswitch.Client.list_route53_health_checks`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/arc-region-switch-2022-07-26/ListRoute53HealthChecks>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          arn='string',
          hostedZoneId='string',
          recordName='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type arn: string
    :param arn: **[REQUIRED]** 

      The Amazon Resource Name (ARN) of the Amazon Route 53 health check request.

      

    
    :type hostedZoneId: string
    :param hostedZoneId: 

      The hosted zone ID for the health checks.

      

    
    :type recordName: string
    :param recordName: 

      The record name for the health checks.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'healthChecks': [
                {
                    'hostedZoneId': 'string',
                    'recordName': 'string',
                    'healthCheckId': 'string',
                    'status': 'healthy'|'unhealthy'|'unknown',
                    '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.

              
            

            - **status** *(string) --* 

              The Amazon Route 53 health check status.

              
            

            - **region** *(string) --* 

              The Amazon Route 53 Region.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    