:doc:`IoTWireless <../../iotwireless>` / Client / list_destinations

*****************
list_destinations
*****************



.. py:method:: IoTWireless.Client.list_destinations(**kwargs)

  

  Lists the destinations registered to your AWS account.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/ListDestinations>`_  


  **Request Syntax**
  ::

    response = client.list_destinations(
        MaxResults=123,
        NextToken='string'
    )
    
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return in this operation.

    

  
  :type NextToken: string
  :param NextToken: 

    To retrieve the next set of results, the ``nextToken`` value from a previous response; otherwise **null** to receive the first set of results.

    

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

    
    ::

      {
          'NextToken': 'string',
          'DestinationList': [
              {
                  'Arn': 'string',
                  'Name': 'string',
                  'ExpressionType': 'RuleName'|'MqttTopic',
                  'Expression': 'string',
                  'Description': 'string',
                  'RoleArn': 'string'
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The token to use to get the next set of results, or **null** if there are no additional results.

        
      

      - **DestinationList** *(list) --* 

        The list of destinations.

        
        

        - *(dict) --* 

          Describes a destination.

          
          

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

            The Amazon Resource Name of the resource.

            
          

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

            The name of the resource.

            
          

          - **ExpressionType** *(string) --* 

            The type of value in ``Expression``.

            
          

          - **Expression** *(string) --* 

            The rule name or topic rule to send messages to.

            
          

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

            The description of the resource.

            
          

          - **RoleArn** *(string) --* 

            The ARN of the IAM Role that authorizes the destination.

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

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

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

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

  