:doc:`TelcoNetworkBuilder <../../tnb>` / Client / list_sol_function_instances

***************************
list_sol_function_instances
***************************



.. py:method:: TelcoNetworkBuilder.Client.list_sol_function_instances(**kwargs)

  

  Lists network function instances.

   

  A network function instance is a function in a function package .

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/tnb-2008-10-21/ListSolFunctionInstances>`_  


  **Request Syntax**
  ::

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

    The maximum number of results to include in the response.

    

  
  :type nextToken: string
  :param nextToken: 

    The token for the next page of results.

    

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

    
    ::

      {
          'functionInstances': [
              {
                  'arn': 'string',
                  'id': 'string',
                  'instantiatedVnfInfo': {
                      'vnfState': 'STARTED'|'STOPPED'
                  },
                  'instantiationState': 'INSTANTIATED'|'NOT_INSTANTIATED',
                  'metadata': {
                      'createdAt': datetime(2015, 1, 1),
                      'lastModified': datetime(2015, 1, 1)
                  },
                  'nsInstanceId': 'string',
                  'vnfPkgId': 'string',
                  'vnfPkgName': 'string'
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **functionInstances** *(list) --* 

        Network function instances.

        
        

        - *(dict) --* 

          Lists information about a network function instance.

           

          A network function instance is a function in a function package .

          
          

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

            Network function instance ARN.

            
          

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

            Network function instance ID.

            
          

          - **instantiatedVnfInfo** *(dict) --* 

            Information about a network function.

             

            A network instance is a single network created in Amazon Web Services TNB that can be deployed and on which life-cycle operations (like terminate, update, and delete) can be performed.

            
            

            - **vnfState** *(string) --* 

              State of the network function.

              
        
          

          - **instantiationState** *(string) --* 

            Network function instance instantiation state.

            
          

          - **metadata** *(dict) --* 

            Network function instance metadata.

            
            

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

              When the network function instance was created.

              
            

            - **lastModified** *(datetime) --* 

              When the network function instance was last modified.

              
        
          

          - **nsInstanceId** *(string) --* 

            Network instance ID.

            
          

          - **vnfPkgId** *(string) --* 

            Function package ID.

            
          

          - **vnfPkgName** *(string) --* 

            Function package name.

            
      
    
      

      - **nextToken** *(string) --* 

        The token to use to retrieve the next page of results. This value is ``null`` when there are no more results to return.

        
  
  **Exceptions**
  
  *   :py:class:`TelcoNetworkBuilder.Client.exceptions.InternalServerException`

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

  
  *   :py:class:`TelcoNetworkBuilder.Client.exceptions.ValidationException`

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

  