Skip to content

Get Analysis Report Results

networkfirewall_get_analysis_report_results R Documentation

The results of a COMPLETED analysis report generated with StartAnalysisReport

Description

The results of a COMPLETED analysis report generated with start_analysis_report.

For more information, see AnalysisTypeReportResult.

Usage

networkfirewall_get_analysis_report_results(FirewallName,
  AnalysisReportId, FirewallArn, NextToken, MaxResults)

Arguments

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.

AnalysisReportId

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

FirewallArn

The Amazon Resource Name (ARN) of the firewall.

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

NextToken

When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

MaxResults

The maximum number of objects that you want Network Firewall to return for this request. If more objects are available, in the response, Network Firewall provides a NextToken value that you can use in a subsequent call to get the next batch of objects.

Value

A list with the following syntax: 

list(
  Status = "string",
  StartTime = as.POSIXct(
    "2015-01-01"
  ),
  EndTime = as.POSIXct(
    "2015-01-01"
  ),
  ReportTime = as.POSIXct(
    "2015-01-01"
  ),
  AnalysisType = "TLS_SNI"|"HTTP_HOST",
  NextToken = "string",
  AnalysisReportResults = list(
    list(
      Protocol = "string",
      FirstAccessed = as.POSIXct(
        "2015-01-01"
      ),
      LastAccessed = as.POSIXct(
        "2015-01-01"
      ),
      Domain = "string",
      Hits = list(
        Count = 123
      ),
      UniqueSources = list(
        Count = 123
      )
    )
  )
)

Request syntax

svc$get_analysis_report_results(
  FirewallName = "string",
  AnalysisReportId = "string",
  FirewallArn = "string",
  NextToken = "string",
  MaxResults = 123
)