:doc:`CloudWatchLogs <../../logs>` / Paginator / DescribeDestinations

********************
DescribeDestinations
********************



.. py:class:: CloudWatchLogs.Paginator.DescribeDestinations

  ::

    
    paginator = client.get_paginator('describe_destinations')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`CloudWatchLogs.Client.describe_destinations`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          DestinationNamePrefix='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type DestinationNamePrefix: string
    :param DestinationNamePrefix: 

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

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :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) --* 

          A token to resume pagination.

          
    