NetworkFirewall / Client / start_analysis_report

start_analysis_report#

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

Request Syntax

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

  • FirewallName (string) –

    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.

  • FirewallArn (string) –

    The Amazon Resource Name (ARN) of the firewall.

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

  • AnalysisType (string) –

    [REQUIRED]

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

Return type:

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