Module Values.FindingSource

Information about a finding that was detected in your code.

Sourcetype nonrec t = {
  1. createdAt : Timestamp.t option;
    (*

    The time when the finding was created.

    *)
  2. description : String_.t option;
    (*

    A description of the finding.

    *)
  3. generatorId : String_.t option;
    (*

    The identifier for the component that generated a finding such as AmazonCodeGuruSecurity.

    *)
  4. id : String_.t option;
    (*

    The identifier for a finding.

    *)
  5. updatedAt : Timestamp.t option;
    (*

    The time when the finding was last updated. Findings are updated when you remediate them or when the finding code location changes.

    *)
  6. type_ : String_.t option;
    (*

    The type of finding.

    *)
  7. status : Status.t option;
    (*

    The status of the finding. A finding status can be open or closed.

    *)
  8. resource : Resource.t option;
    (*

    The resource where Amazon CodeGuru Security detected a finding.

    *)
  9. vulnerability : Vulnerability.t option;
    (*

    An object that describes the detected security vulnerability.

    *)
  10. severity : Severity.t option;
    (*

    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.

    *)
  11. remediation : Remediation.t option;
    (*

    An object that contains the details about how to remediate a finding.

    *)
  12. title : String_.t option;
    (*

    The title of the finding.

    *)
  13. detectorTags : DetectorTags.t option;
    (*

    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.

    *)
  14. detectorId : String_.t option;
    (*

    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.

    *)
  15. detectorName : String_.t option;
    (*

    The name of the detector that identified the security vulnerability in your code.

    *)
  16. ruleId : String_.t option;
    (*

    The identifier for the rule that generated the finding.

    *)
}
Sourceval make : ?createdAt:??? -> ?description:??? -> ?generatorId:??? -> ?id:??? -> ?updatedAt:??? -> ?type_:??? -> ?status:??? -> ?resource:??? -> ?vulnerability:??? -> ?severity:??? -> ?remediation:??? -> ?title:??? -> ?detectorTags:??? -> ?detectorId:??? -> ?detectorName:??? -> ?ruleId:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `String of String_.t ] list | `String of String_.t | `Structure of (string * [> `Integer of Integer.t | `List of [> `String of String_.t | `Structure of (string * [> `String of String_.t ]) list ] list | `String of String_.t | `Structure of (string * [> `Integer of Integer.t | `List of [> `Structure of (string * [> `Integer of Integer.t | `String of String_.t ]) list ] list | `String of String_.t ]) list ]) list | `Timestamp of Timestamp.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t