:doc:`VPCLattice <../../vpc-lattice>` / Paginator / ListServices

************
ListServices
************



.. py:class:: VPCLattice.Paginator.ListServices

  ::

    
    paginator = client.get_paginator('list_services')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`VPCLattice.Client.list_services`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/vpc-lattice-2022-11-30/ListServices>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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**

      
      ::

        {
            'items': [
                {
                    'id': 'string',
                    'name': 'string',
                    'arn': 'string',
                    'createdAt': datetime(2015, 1, 1),
                    'lastUpdatedAt': datetime(2015, 1, 1),
                    'dnsEntry': {
                        'domainName': 'string',
                        'hostedZoneId': 'string'
                    },
                    'customDomainName': 'string',
                    'status': 'ACTIVE'|'CREATE_IN_PROGRESS'|'DELETE_IN_PROGRESS'|'CREATE_FAILED'|'DELETE_FAILED'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **items** *(list) --* 

          Information about the services.

          
          

          - *(dict) --* 

            Summary information about a service.

            
            

            - **id** *(string) --* 

              The ID of the service.

              
            

            - **name** *(string) --* 

              The name of the service.

              
            

            - **arn** *(string) --* 

              The Amazon Resource Name (ARN) of the service.

              
            

            - **createdAt** *(datetime) --* 

              The date and time that the service was created, in ISO-8601 format.

              
            

            - **lastUpdatedAt** *(datetime) --* 

              The date and time that the service was last updated, in ISO-8601 format.

              
            

            - **dnsEntry** *(dict) --* 

              The DNS information.

              
              

              - **domainName** *(string) --* 

                The domain name of the service.

                
              

              - **hostedZoneId** *(string) --* 

                The ID of the hosted zone.

                
          
            

            - **customDomainName** *(string) --* 

              The custom domain name of the service.

              
            

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

              The status.

              
        
      
        

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

          A token to resume pagination.

          
    