NetworkFirewall / Paginator / GetAnalysisReportResults

GetAnalysisReportResults#

class NetworkFirewall.Paginator.GetAnalysisReportResults#

paginator = client.get_paginator('get_analysis_report_results')

paginate(**kwargs)#

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

Request Syntax

response_iterator = paginator.paginate(
    FirewallName='string',
    AnalysisReportId='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.
AnalysisReportId (string) –
[REQUIRED]

The unique ID of the query that ran when you requested an analysis report.
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

{
    'Status': 'string',
    'StartTime': datetime(2015, 1, 1),
    'EndTime': datetime(2015, 1, 1),
    'ReportTime': datetime(2015, 1, 1),
    'AnalysisType': 'TLS_SNI'|'HTTP_HOST',
    'AnalysisReportResults': [
        {
            'Protocol': 'string',
            'FirstAccessed': datetime(2015, 1, 1),
            'LastAccessed': datetime(2015, 1, 1),
            'Domain': 'string',
            'Hits': {
                'Count': 123
            },
            'UniqueSources': {
                'Count': 123
            }
        },
    ]
}

Response Structure

(dict) –
- Status (string) –
  
  The status of the analysis report you specify. Statuses include RUNNING, COMPLETED, or FAILED.
- StartTime (datetime) –
  
  The date and time within the last 30 days from which to start retrieving analysis data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ.
- EndTime (datetime) –
  
  The date and time, up to the current date, from which to stop retrieving analysis data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
- ReportTime (datetime) –
  
  The date and time the analysis report was ran.
- AnalysisType (string) –
  
  The type of traffic that will be used to generate a report.
- AnalysisReportResults (list) –
  
  Retrieves the results of a traffic analysis report.
  - (dict) –
    
    The results of a COMPLETED analysis report generated with StartAnalysisReport.
    
    For an example of traffic analysis report results, see the response syntax of GetAnalysisReportResults.
    - Protocol (string) –
      
      The type of traffic captured by the analysis report.
    - FirstAccessed (datetime) –
      
      The date and time any domain was first accessed (within the last 30 day period).
    - LastAccessed (datetime) –
      
      The date and time any domain was last accessed (within the last 30 day period).
    - Domain (string) –
      
      The most frequently accessed domains.
    - Hits (dict) –
      
      The number of attempts made to access a observed domain.
      - Count (integer) –
        
        The number of attempts made to access a domain.
    - UniqueSources (dict) –
      
      The number of unique source IP addresses that connected to a domain.
      - Count (integer) –
        
        The number of unique source IP addresses that connected to a domain.