Skip to content

This API is currently available as a preview

Description

This API is currently available as a preview. This feature is available in the following Amazon Web Services Regions: US East (N. Virginia), US East (Ohio), US West (Oregon), Canada (Central), Europe (Frankfurt), Europe (Ireland), Europe (London), Europe (Paris), Europe (Stockholm), and Asia Pacific (Tokyo).

Returns a list of investigations associated with the specified GuardDuty detector.

An administrator account sees all investigations across the organization. Member accounts see only the investigations that belong to them.

Usage

guardduty_list_investigations(DetectorId, SortCriteria, MaxResults,
  NextToken)

Arguments

  • DetectorId

[required] The unique ID of the GuardDuty detector whose investigations you want to list.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the list_detectors API.

  • SortCriteria

Represents the criteria used for sorting investigations.

  • MaxResults

You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50.

  • NextToken

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

Value

A list with the following syntax:

list(
  Investigations = list(
    list(
      InvestigationId = "string",
      Status = "RUNNING"|"COMPLETED"|"FAILED",
      TriggerPrompt = "string",
      RiskLevel = "Info"|"Low"|"Medium"|"High"|"Critical",
      Confidence = "Unknown"|"Low"|"Medium"|"High",
      Title = "string",
      AccountId = "string",
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_investigations(
  DetectorId = "string",
  SortCriteria = list(
    AttributeName = "START_TIME"|"END_TIME"|"STATUS"|"RISK_LEVEL"|"CONFIDENCE",
    OrderBy = "ASC"|"DESC"
  ),
  MaxResults = 123,
  NextToken = "string"
)