:doc:`NetworkFirewall <../../network-firewall>` / Client / start_analysis_report

*********************
start_analysis_report
*********************



.. py:method:: NetworkFirewall.Client.start_analysis_report(**kwargs)

  

  Generates a traffic analysis report for the timeframe and traffic type you specify.

   

  For information on the contents of a traffic analysis report, see  AnalysisReport.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/StartAnalysisReport>`_  


  **Request Syntax**
  ::

    response = client.start_analysis_report(
        FirewallName='string',
        FirewallArn='string',
        AnalysisType='TLS_SNI'|'HTTP_HOST'
    )
    
  :type FirewallName: string
  :param FirewallName: 

    The descriptive name of the firewall. You can't change the name of a firewall after you create it.

     

    You must specify the ARN or the name, and you can specify both.

    

  
  :type FirewallArn: string
  :param FirewallArn: 

    The Amazon Resource Name (ARN) of the firewall.

     

    You must specify the ARN or the name, and you can specify both.

    

  
  :type AnalysisType: string
  :param AnalysisType: **[REQUIRED]** 

    The type of traffic that will be used to generate a report.

    

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

    
    ::

      {
          'AnalysisReportId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **AnalysisReportId** *(string) --* 

        The unique ID of the query that ran when you requested an analysis report.

        
  
  **Exceptions**
  
  *   :py:class:`NetworkFirewall.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`NetworkFirewall.Client.exceptions.InternalServerError`

  
  *   :py:class:`NetworkFirewall.Client.exceptions.ResourceNotFoundException`

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

  