:doc:`ManagedBlockchain <../../managedblockchain>` / Client / list_networks

*************
list_networks
*************



.. py:method:: ManagedBlockchain.Client.list_networks(**kwargs)

  

  Returns information about the networks in which the current Amazon Web Services account participates.

   

  Applies to Hyperledger Fabric and Ethereum.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/managedblockchain-2018-09-24/ListNetworks>`_  


  **Request Syntax**
  ::

    response = client.list_networks(
        Name='string',
        Framework='HYPERLEDGER_FABRIC'|'ETHEREUM',
        Status='CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED',
        MaxResults=123,
        NextToken='string'
    )
    
  :type Name: string
  :param Name: 

    The name of the network.

    

  
  :type Framework: string
  :param Framework: 

    An optional framework specifier. If provided, only networks of this framework type are listed.

    

  
  :type Status: string
  :param Status: 

    An optional status specifier. If provided, only networks currently in this status are listed.

     

    Applies only to Hyperledger Fabric.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of networks to list.

    

  
  :type NextToken: string
  :param NextToken: 

    The pagination token that indicates the next set of results to retrieve.

    

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

    
    ::

      {
          'Networks': [
              {
                  'Id': 'string',
                  'Name': 'string',
                  'Description': 'string',
                  'Framework': 'HYPERLEDGER_FABRIC'|'ETHEREUM',
                  'FrameworkVersion': 'string',
                  'Status': 'CREATING'|'AVAILABLE'|'CREATE_FAILED'|'DELETING'|'DELETED',
                  'CreationDate': datetime(2015, 1, 1),
                  'Arn': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Networks** *(list) --* 

        An array of ``NetworkSummary`` objects that contain configuration properties for each network.

        
        

        - *(dict) --* 

          A summary of network configuration properties.

          
          

          - **Id** *(string) --* 

            The unique identifier of the network.

            
          

          - **Name** *(string) --* 

            The name of the network.

            
          

          - **Description** *(string) --* 

            An optional description of the network.

            
          

          - **Framework** *(string) --* 

            The blockchain framework that the network uses.

            
          

          - **FrameworkVersion** *(string) --* 

            The version of the blockchain framework that the network uses.

            
          

          - **Status** *(string) --* 

            The current status of the network.

            
          

          - **CreationDate** *(datetime) --* 

            The date and time that the network was created.

            
          

          - **Arn** *(string) --* 

            The Amazon Resource Name (ARN) of the network. For more information about ARNs and their format, see `Amazon Resource Names (ARNs) <https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html>`__ in the *Amazon Web Services General Reference*.

            
      
    
      

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

        The pagination token that indicates the next set of results to retrieve.

        
  
  **Exceptions**
  
  *   :py:class:`ManagedBlockchain.Client.exceptions.InvalidRequestException`

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

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

  
  *   :py:class:`ManagedBlockchain.Client.exceptions.InternalServiceErrorException`

  