Module types

Source
Expand description

Data structures used by operation inputs/outputs.

Modules§

builders
Builders
error
Error types that Amazon CodeGuru Security can respond with.

Structs§

AccountFindingsMetric

A summary of findings metrics for an account on a specified date.

BatchGetFindingsError

Contains information about the error that caused a finding to fail to be retrieved.

CategoryWithFindingNum

Information about a finding category with open findings.

CodeLine

The line of code where a finding was detected.

EncryptionConfig

Information about the encryption configuration for an account. Required to call UpdateAccountConfiguration.

FilePath

Information about the location of security vulnerabilities that Amazon CodeGuru Security detected in your code.

Finding

Information about a finding that was detected in your code.

FindingIdentifier

An object that contains information about a finding and the scan that generated it.

FindingMetricsValuePerSeverity

A numeric value corresponding to the severity of a finding, such as the number of open findings or the average time it takes to close findings of a given severity.

MetricsSummary

A summary of metrics for an account as of a specified date.

Recommendation

Information about the recommended course of action to remediate a finding.

Remediation

Information about how to remediate a finding.

Resource

Information about a resource that contains a finding.

ScanNameWithFindingNum

Information about the number of findings generated by a scan.

ScanSummary

Information about a scan.

SuggestedFix

Information about the suggested code fix to remediate a finding.

ValidationExceptionField

Information about a validation exception.

Vulnerability

Information about a security vulnerability that Amazon CodeGuru Security detected.

Enums§

AnalysisType
When writing a match expression against AnalysisType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ErrorCode
When writing a match expression against ErrorCode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ResourceId

The identifier for a resource object that contains resources to scan. Specifying a codeArtifactId is required to create a scan.

ScanState
When writing a match expression against ScanState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ScanType
When writing a match expression against ScanType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
Severity
When writing a match expression against Severity, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
Status
When writing a match expression against Status, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ValidationExceptionReason
When writing a match expression against ValidationExceptionReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.