Struct Finding

#[non_exhaustive]
pub struct Finding {

    pub created_at: Option<DateTime>,
    pub description: Option<String>,
    pub generator_id: Option<String>,
    pub id: Option<String>,
    pub updated_at: Option<DateTime>,
    pub type: Option<String>,
    pub status: Option<Status>,
    pub resource: Option<Resource>,
    pub vulnerability: Option<Vulnerability>,
    pub severity: Option<Severity>,
    pub remediation: Option<Remediation>,
    pub title: Option<String>,
    pub detector_tags: Option<Vec<String>>,
    pub detector_id: Option<String>,
    pub detector_name: Option<String>,
    pub rule_id: Option<String>,
}

Information about a finding that was detected in your code.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

created_at: Option<DateTime>

The time when the finding was created.

description: Option<String>

A description of the finding.

generator_id: Option<String>

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

id: Option<String>

The identifier for a finding.

updated_at: Option<DateTime>

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

type: Option<String>

The type of finding.

status: Option<Status>

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

resource: Option<Resource>

The resource where Amazon CodeGuru Security detected a finding.

vulnerability: Option<Vulnerability>

An object that describes the detected security vulnerability.

severity: Option<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.

remediation: Option<Remediation>

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

title: Option<String>

The title of the finding.

detector_tags: Option<Vec<String>>

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.

detector_id: Option<String>

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.

detector_name: Option<String>

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

rule_id: Option<String>

The identifier for the rule that generated the finding.

Implementations

impl Finding

pub fn created_at(&self) -> Option<&DateTime>

The time when the finding was created.

pub fn description(&self) -> Option<&str>

A description of the finding.

pub fn generator_id(&self) -> Option<&str>

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

pub fn id(&self) -> Option<&str>

The identifier for a finding.

pub fn updated_at(&self) -> Option<&DateTime>

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

pub fn type(&self) -> Option<&str>

The type of finding.

pub fn status(&self) -> Option<&Status>

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

pub fn resource(&self) -> Option<&Resource>

The resource where Amazon CodeGuru Security detected a finding.

pub fn vulnerability(&self) -> Option<&Vulnerability>

An object that describes the detected security vulnerability.

pub fn severity(&self) -> Option<&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.

pub fn remediation(&self) -> Option<&Remediation>

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

pub fn title(&self) -> Option<&str>

The title of the finding.

pub fn detector_tags(&self) -> &[String]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .detector_tags.is_none().

pub fn detector_id(&self) -> Option<&str>

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.

pub fn detector_name(&self) -> Option<&str>

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

pub fn rule_id(&self) -> Option<&str>

The identifier for the rule that generated the finding.

impl Finding

pub fn builder() -> FindingBuilder

Creates a new builder-style object to manufacture Finding.

Trait Implementations

impl Clone for Finding

fn clone(&self) -> Finding

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Finding

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Finding

fn eq(&self, other: &Finding) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Finding