:doc:`VPCLattice <../../vpc-lattice>` / Client / list_services

*************
list_services
*************



.. py:method:: VPCLattice.Client.list_services(**kwargs)

  

  Lists the services owned by the caller account or shared with the caller account.

  

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


  **Request Syntax**
  ::

    response = client.list_services(
        maxResults=123,
        nextToken='string'
    )
    
  :type maxResults: integer
  :param maxResults: 

    The maximum number of results to return.

    

  
  :type nextToken: string
  :param nextToken: 

    A pagination token for the next page of results.

    

  
  
  :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) --* 

        If there are additional results, a pagination token for the next page of results.

        
  
  **Exceptions**
  
  *   :py:class:`VPCLattice.Client.exceptions.ValidationException`

  
  *   :py:class:`VPCLattice.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`VPCLattice.Client.exceptions.ThrottlingException`

  
  *   :py:class:`VPCLattice.Client.exceptions.InternalServerException`

  