Investigation
Contains the details and results of a GuardDuty investigation.
Contents
- investigationId
-
The unique identifier of the investigation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-fA-F0-9\-]+Required: Yes
- status
-
The current status of the investigation. Possible values are
RUNNING,COMPLETED, andFAILED.Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Valid Values:
RUNNING | COMPLETED | FAILEDRequired: Yes
- triggeredBy
-
The account that initiated the investigation.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: Yes
- triggerPrompt
-
The natural-language prompt that initiated this investigation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
- cloud
-
Details about the cloud environment in which the investigation was performed, including the provider, region, and account.
Type: CloudDetails object
Required: No
- confidence
-
The confidence level of the investigation's assessment. Possible values are
Unknown,Low,Medium, andHigh.Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Valid Values:
Unknown | Low | Medium | HighRequired: No
- endTime
-
The timestamp at which the investigation completed.
Type: Timestamp
Required: No
- error
-
Details about the error if the investigation status is
FAILED.Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
- metadata
-
Metadata about the product and version that produced the investigation.
Type: InvestigationMetadata object
Required: No
- risk
-
A human-readable description of the assessed risk.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
- riskLevel
-
The assessed risk level of the investigated threat. Possible values are
Info,Low,Medium,High, andCritical.Type: String
Length Constraints: Minimum length of 1. Maximum length of 300.
Valid Values:
Info | Low | Medium | High | CriticalRequired: No
- scope
-
Information about what the investigation analyzed, including the investigation type, the finding, account, or organization that was analyzed, and, for
ACCOUNTandORGANIZATIONinvestigations, the time window over which the investigation queried data. Returned only when the investigation status isCOMPLETED.Type: InvestigationScope object
Required: No
- startTime
-
The timestamp at which the investigation started.
Type: Timestamp
Required: No
- summary
-
A summary of the investigation results as text, up to 262,144 characters. Returned only when the investigation status is
COMPLETED. When you setSummaryFormattoSTRUCTURED, the summary is returned inSummaryDatainstead, unless it isn't available in a structured form, in which case it's returned in this field.Type: String
Length Constraints: Minimum length of 0. Maximum length of 262144.
Required: No
- summaryData
-
A structured summary of the investigation results. GuardDuty returns this field only when you set
SummaryFormattoSTRUCTURED, the investigation status isCOMPLETED, and the summary is available in a structured form. When this field is returned,Summaryisn't returned.Type: InvestigationSummaryData object
Required: No
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: