:doc:`CloudWatchLogs <../../logs>` / Client / describe_destinations

*********************
describe_destinations
*********************



.. py:method:: CloudWatchLogs.Client.describe_destinations(**kwargs)

  

  Lists all your destinations. The results are ASCII-sorted by destination name.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/DescribeDestinations>`_  


  **Request Syntax**
  ::

    response = client.describe_destinations(
        DestinationNamePrefix='string',
        nextToken='string',
        limit=123
    )
    
  :type DestinationNamePrefix: string
  :param DestinationNamePrefix: 

    The prefix to match. If you don't specify a value, no prefix filter is applied.

    

  
  :type nextToken: string
  :param nextToken: 

    The token for the next set of items to return. (You received this token from a previous call.)

    

  
  :type limit: integer
  :param limit: 

    The maximum number of items returned. If you don't specify a value, the default maximum value of 50 items is used.

    

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

    
    ::

      {
          'destinations': [
              {
                  'destinationName': 'string',
                  'targetArn': 'string',
                  'roleArn': 'string',
                  'accessPolicy': 'string',
                  'arn': 'string',
                  'creationTime': 123
              },
          ],
          'nextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **destinations** *(list) --* 

        The destinations.

        
        

        - *(dict) --* 

          Represents a cross-account destination that receives subscription log events.

          
          

          - **destinationName** *(string) --* 

            The name of the destination.

            
          

          - **targetArn** *(string) --* 

            The Amazon Resource Name (ARN) of the physical target where the log events are delivered (for example, a Kinesis stream).

            
          

          - **roleArn** *(string) --* 

            A role for impersonation, used when delivering log events to the target.

            
          

          - **accessPolicy** *(string) --* 

            An IAM policy document that governs which Amazon Web Services accounts can create subscription filters against this destination.

            
          

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

            The ARN of this destination.

            
          

          - **creationTime** *(integer) --* 

            The creation time of the destination, expressed as the number of milliseconds after Jan 1, 1970 00:00:00 UTC.

            
      
    
      

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

        The token for the next set of items to return. The token expires after 24 hours.

        
  
  **Exceptions**
  
  *   :py:class:`CloudWatchLogs.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`CloudWatchLogs.Client.exceptions.ServiceUnavailableException`

  