NetworkFirewall / Paginator / ListAnalysisReports

ListAnalysisReports

class NetworkFirewall.Paginator.ListAnalysisReports
paginator = client.get_paginator('list_analysis_reports')
paginate(**kwargs)

Creates an iterator that will paginate through responses from NetworkFirewall.Client.list_analysis_reports().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    FirewallName='string',
    FirewallArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
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.

  • PaginationConfig (dict) –

    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.

Return type:

dict

Returns:

Response Syntax

{
    'AnalysisReports': [
        {
            'AnalysisReportId': 'string',
            'AnalysisType': 'TLS_SNI'|'HTTP_HOST',
            'ReportTime': datetime(2015, 1, 1),
            'Status': 'string'
        },
    ],

}

Response Structure

  • (dict) –

    • AnalysisReports (list) –

      The id and ReportTime associated with a requested analysis report. Does not provide the status of the analysis report.

      • (dict) –

        A report that captures key activity from the last 30 days of network traffic monitored by your firewall.

        You can generate up to one report per traffic type, per 30 day period. For example, when you successfully create an HTTP traffic report, you cannot create another HTTP traffic report until 30 days pass. Alternatively, if you generate a report that combines metrics on both HTTP and HTTPS traffic, you cannot create another report for either traffic type until 30 days pass.

        • AnalysisReportId (string) –

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

        • AnalysisType (string) –

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

        • ReportTime (datetime) –

          The date and time the analysis report was ran.

        • Status (string) –

          The status of the analysis report you specify. Statuses include RUNNING, COMPLETED, or FAILED.