:doc:`MediaLive <../../medialive>` / Client / list_nodes

**********
list_nodes
**********



.. py:method:: MediaLive.Client.list_nodes(**kwargs)

  Retrieve the list of Nodes.

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/medialive-2017-10-14/ListNodes>`_  


  **Request Syntax**
  ::

    response = client.list_nodes(
        ClusterId='string',
        MaxResults=123,
        NextToken='string'
    )
    
  :type ClusterId: string
  :param ClusterId: **[REQUIRED]** The ID of the cluster

  
  :type MaxResults: integer
  :param MaxResults: The maximum number of items to return.

  
  :type NextToken: string
  :param NextToken: The token to retrieve the next page of results.

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

    
    ::

      {
          'NextToken': 'string',
          'Nodes': [
              {
                  'Arn': 'string',
                  'ChannelPlacementGroups': [
                      'string',
                  ],
                  'ClusterId': 'string',
                  'ConnectionState': 'CONNECTED'|'DISCONNECTED',
                  'Id': 'string',
                  'InstanceArn': 'string',
                  'ManagedInstanceId': 'string',
                  'Name': 'string',
                  'NodeInterfaceMappings': [
                      {
                          'LogicalInterfaceName': 'string',
                          'NetworkInterfaceMode': 'NAT'|'BRIDGE',
                          'PhysicalInterfaceName': 'string',
                          'PhysicalInterfaceIpAddresses': [
                              'string',
                          ]
                      },
                  ],
                  'Role': 'BACKUP'|'ACTIVE',
                  'State': 'CREATED'|'REGISTERING'|'READY_TO_ACTIVATE'|'REGISTRATION_FAILED'|'ACTIVATION_FAILED'|'ACTIVE'|'READY'|'IN_USE'|'DEREGISTERING'|'DRAINING'|'DEREGISTRATION_FAILED'|'DEREGISTERED',
                  'SdiSourceMappings': [
                      {
                          'CardNumber': 123,
                          'ChannelNumber': 123,
                          'SdiSource': 'string'
                      },
                  ]
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* An array of nodes.
      

      - **NextToken** *(string) --* Token for the next result.
      

      - **Nodes** *(list) --* An array of Nodes that exist in the Cluster.
        

        - *(dict) --* Placeholder documentation for DescribeNodeSummary
          

          - **Arn** *(string) --* The ARN of the Node. It is automatically assigned when the Node is created.
          

          - **ChannelPlacementGroups** *(list) --* An array of IDs. Each ID is one ChannelPlacementGroup that is associated with this Node. Empty if the Node is not yet associated with any groups.
            

            - *(string) --* Placeholder documentation for __string
        
          

          - **ClusterId** *(string) --* The ID of the Cluster that the Node belongs to.
          

          - **ConnectionState** *(string) --* The current connection state of the Node.
          

          - **Id** *(string) --* The unique ID of the Node. Unique in the Cluster. The ID is the resource-id portion of the ARN.
          

          - **InstanceArn** *(string) --* The EC2 ARN of the Instance associated with the Node.
          

          - **ManagedInstanceId** *(string) --* At the routing layer will get it from the callerId/context for use with bring your own device.
          

          - **Name** *(string) --* The name that you specified for the Node.
          

          - **NodeInterfaceMappings** *(list) --* Documentation update needed
            

            - *(dict) --* A mapping that's used to pair a logical network interface name on a Node with the physical interface name exposed in the operating system.
              

              - **LogicalInterfaceName** *(string) --* A uniform logical interface name to address in a MediaLive channel configuration.
              

              - **NetworkInterfaceMode** *(string) --* Used in NodeInterfaceMapping and NodeInterfaceMappingCreateRequest
              

              - **PhysicalInterfaceName** *(string) --* The name of the physical interface on the hardware that will be running Elemental anywhere.
              

              - **PhysicalInterfaceIpAddresses** *(list) --* The IP addresses associated with the physical interface on the node hardware.
                

                - *(string) --* Placeholder documentation for __string
            
          
        
          

          - **Role** *(string) --* The initial role current role of the Node in the Cluster. ACTIVE means the Node is available for encoding. BACKUP means the Node is a redundant Node and might get used if an ACTIVE Node fails.
          

          - **State** *(string) --* The current state of the Node.
          

          - **SdiSourceMappings** *(list) --* An array of SDI source mappings. Each mapping connects one logical SdiSource to the physical SDI card and port that the physical SDI source uses.
            

            - *(dict) --* Used in DescribeNodeSummary, DescribeNodeResult.
              

              - **CardNumber** *(integer) --* A number that uniquely identifies the SDI card on the node hardware.
              

              - **ChannelNumber** *(integer) --* A number that uniquely identifies a port on the SDI card.
              

              - **SdiSource** *(string) --* The ID of the SdiSource to associate with this port on this card. You can use the ListSdiSources operation to discover all the IDs.
          
        
      
    
  
  **Exceptions**
  
  *   :py:class:`MediaLive.Client.exceptions.BadRequestException`

  
  *   :py:class:`MediaLive.Client.exceptions.InternalServerErrorException`

  
  *   :py:class:`MediaLive.Client.exceptions.ForbiddenException`

  
  *   :py:class:`MediaLive.Client.exceptions.BadGatewayException`

  
  *   :py:class:`MediaLive.Client.exceptions.GatewayTimeoutException`

  
  *   :py:class:`MediaLive.Client.exceptions.TooManyRequestsException`

  