Finding
Information about a finding that was detected in your code.
Contents
- createdAt
-
The time when the finding was created.
Type: Timestamp
Required: No
- description
-
A description of the finding.
Type: String
Required: No
- detectorId
-
The identifier for the detector that detected the finding in your code. A detector is a defined rule based on industry standards and AWS best practices.
Type: String
Required: No
- detectorName
-
The name of the detector that identified the security vulnerability in your code.
Type: String
Required: No
- detectorTags
-
One or more tags or categorizations that are associated with a detector. These tags are defined by type, programming language, or other classification such as maintainability or consistency.
Type: Array of strings
Required: No
- generatorId
-
The identifier for the component that generated a finding such as AmazonCodeGuruSecurity.
Type: String
Required: No
- id
-
The identifier for a finding.
Type: String
Required: No
- remediation
-
An object that contains the details about how to remediate a finding.
Type: Remediation object
Required: No
- resource
-
The resource where Amazon CodeGuru Security detected a finding.
Type: Resource object
Required: No
- ruleId
-
The identifier for the rule that generated the finding.
Type: String
Required: No
- severity
-
The severity of the finding. Severity can be critical, high, medium, low, or informational. For information on severity levels, see Finding severity in the Amazon CodeGuru Security User Guide.
Type: String
Valid Values:
Critical | High | Medium | Low | InfoRequired: No
- status
-
The status of the finding. A finding status can be open or closed.
Type: String
Valid Values:
Closed | Open | AllRequired: No
- title
-
The title of the finding.
Type: String
Required: No
- type
-
The type of finding.
Type: String
Required: No
- updatedAt
-
The time when the finding was last updated. Findings are updated when you remediate them or when the finding code location changes.
Type: Timestamp
Required: No
- vulnerability
-
An object that describes the detected security vulnerability.
Type: Vulnerability object
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
