:doc:`SecurityHub <../../securityhub>` / Client / list_finding_aggregators

************************
list_finding_aggregators
************************



.. py:method:: SecurityHub.Client.list_finding_aggregators(**kwargs)

  

  If cross-Region aggregation is enabled, then ``ListFindingAggregators`` returns the Amazon Resource Name (ARN) of the finding aggregator. You can run this operation from any Amazon Web Services Region.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/securityhub-2018-10-26/ListFindingAggregators>`_  


  **Request Syntax**
  ::

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

    The token returned with the previous set of results. Identifies the next set of results to return.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of results to return. This operation currently only returns a single result.

    

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

    
    ::

      {
          'FindingAggregators': [
              {
                  'FindingAggregatorArn': 'string'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **FindingAggregators** *(list) --* 

        The list of finding aggregators. This operation currently only returns a single result.

        
        

        - *(dict) --* 

          A finding aggregator is a Security Hub resource that specifies cross-Region aggregation settings, including the home Region and any linked Regions.

          
          

          - **FindingAggregatorArn** *(string) --* 

            The ARN of the finding aggregator. You use the finding aggregator ARN to retrieve details for, update, and delete the finding aggregator.

            
      
    
      

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

        If there are more results, this is the token to provide in the next call to ``ListFindingAggregators``.

         

        This operation currently only returns a single result.

        
  
  **Exceptions**
  
  *   :py:class:`SecurityHub.Client.exceptions.InternalException`

  
  *   :py:class:`SecurityHub.Client.exceptions.LimitExceededException`

  
  *   :py:class:`SecurityHub.Client.exceptions.InvalidAccessException`

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

  
  *   :py:class:`SecurityHub.Client.exceptions.InvalidInputException`

  