:doc:`CodeStarNotifications <../../codestar-notifications>` / Paginator / ListTargets

***********
ListTargets
***********



.. py:class:: CodeStarNotifications.Paginator.ListTargets

  ::

    
    paginator = client.get_paginator('list_targets')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CodeStarNotifications.Client.list_targets`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codestar-notifications-2019-10-15/ListTargets>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          Filters=[
              {
                  'Name': 'TARGET_TYPE'|'TARGET_ADDRESS'|'TARGET_STATUS',
                  'Value': 'string'
              },
          ],
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type Filters: list
    :param Filters: 

      The filters to use to return information by service or resource type. Valid filters include target type, target address, and target status.

       

      .. note::

        

        A filter with the same name can appear more than once when used with OR statements. Filters with different names should be applied with AND statements.

        

      

    
      - *(dict) --* 

        Information about a filter to apply to the list of returned targets. You can filter by target type, address, or status. For example, to filter results to notification rules that have active Amazon Q Developer in chat applications topics as targets, you could specify a ListTargetsFilter Name as ``TargetType`` and a Value of ``SNS``, and a Name of ``TARGET_STATUS`` and a Value of ``ACTIVE``.

        

      
        - **Name** *(string) --* **[REQUIRED]** 

          The name of the attribute you want to use to filter the returned targets.

          

        
        - **Value** *(string) --* **[REQUIRED]** 

          The value of the attribute you want to use to filter the returned targets. For example, if you specify ``SNS`` for the Target type, you could specify an Amazon Resource Name (ARN) for a topic as the value.

          

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

      
      ::

        {
            'Targets': [
                {
                    'TargetAddress': 'string',
                    'TargetType': 'string',
                    'TargetStatus': 'PENDING'|'ACTIVE'|'UNREACHABLE'|'INACTIVE'|'DEACTIVATED'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Targets** *(list) --* 

          The list of notification rule targets.

          
          

          - *(dict) --* 

            Information about the targets specified for a notification rule.

            
            

            - **TargetAddress** *(string) --* 

              The Amazon Resource Name (ARN) of the Amazon Q Developer in chat applications topic or Amazon Q Developer in chat applications client.

              
            

            - **TargetType** *(string) --* 

              The type of the target (for example, ``SNS``).

               

              
              * Amazon Q Developer in chat applications topics are specified as ``SNS``.
               
              * Amazon Q Developer in chat applications clients are specified as ``AWSChatbotSlack``.
              

              
            

            - **TargetStatus** *(string) --* 

              The status of the target.

              
        
      
    