Codeguru Security Classes
AccountFindingsMetric
closedFindings
- Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.FindingMetricsValuePerSeverity]
date
- Type: typing.Optional[datetime.datetime]
meanTimeToClose
- Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.FindingMetricsValuePerSeverity]
newFindings
- Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.FindingMetricsValuePerSeverity]
openFindings
- Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.FindingMetricsValuePerSeverity]
BaseValidatorModel
Oops! This Pydantic model is currently empty. Stay tuned!
BatchGetFindingsError
errorCode
- Type: typing.Literal['DUPLICATE_IDENTIFIER', 'INTERNAL_ERROR', 'INVALID_FINDING_ID', 'INVALID_SCAN_NAME', 'ITEM_DOES_NOT_EXIST']
- Required: Yes
findingId
- Type:
- Required: Yes
message
- Type:
- Required: Yes
scanName
- Type:
- Required: Yes
BatchGetFindingsRequest
findingIdentifiers
- Type: typing.List[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.FindingIdentifier]
- Required: Yes
BatchGetFindingsResponse
failedFindings
- Type: typing.List[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.BatchGetFindingsError]
- Required: Yes
findings
- Type: typing.List[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.Finding]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CategoryWithFindingNum
categoryName
- Type: typing.Optional[str]
findingNumber
- Type: typing.Optional[int]
CodeLine
content
- Type: typing.Optional[str]
number
- Type: typing.Optional[int]
CreateScanRequest
resourceId
- Type:
- Required: Yes
scanName
- Type:
- Required: Yes
analysisType
- Type: typing.Optional[typing.Literal['All', 'Security']]
clientToken
- Type: typing.Optional[str]
scanType
- Type: typing.Optional[typing.Literal['Express', 'Standard']]
tags
- Type: typing.Optional[typing.Dict[str, str]]
CreateScanResponse
resourceId
- Type:
- Required: Yes
runId
- Type:
- Required: Yes
scanName
- Type:
- Required: Yes
scanNameArn
- Type:
- Required: Yes
scanState
- Type: typing.Literal['Failed', 'InProgress', 'Successful']
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
CreateUploadUrlRequest
scanName
- Type:
- Required: Yes
CreateUploadUrlResponse
codeArtifactId
- Type:
- Required: Yes
requestHeaders
- Type: typing.Dict[str, str]
- Required: Yes
s3Url
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
EncryptionConfig
kmsKeyArn
- Type: typing.Optional[str]
FilePath
codeSnippet
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.CodeLine]]
endLine
- Type: typing.Optional[int]
name
- Type: typing.Optional[str]
path
- Type: typing.Optional[str]
startLine
- Type: typing.Optional[int]
Finding
createdAt
- Type: typing.Optional[datetime.datetime]
description
- Type: typing.Optional[str]
detectorId
- Type: typing.Optional[str]
detectorName
- Type: typing.Optional[str]
detectorTags
- Type: typing.Optional[typing.List[str]]
generatorId
- Type: typing.Optional[str]
id
- Type: typing.Optional[str]
remediation
- Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.Remediation]
resource
- Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.Resource]
ruleId
- Type: typing.Optional[str]
severity
- Type: typing.Optional[typing.Literal['Critical', 'High', 'Info', 'Low', 'Medium']]
status
- Type: typing.Optional[typing.Literal['All', 'Closed', 'Open']]
title
- Type: typing.Optional[str]
type
- Type: typing.Optional[str]
updatedAt
- Type: typing.Optional[datetime.datetime]
vulnerability
- Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.Vulnerability]
FindingIdentifier
findingId
- Type:
- Required: Yes
scanName
- Type:
- Required: Yes
FindingMetricsValuePerSeverity
critical
- Type: typing.Optional[float]
high
- Type: typing.Optional[float]
info
- Type: typing.Optional[float]
low
- Type: typing.Optional[float]
medium
- Type: typing.Optional[float]
GetAccountConfigurationResponse
encryptionConfig
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetFindingsRequest
scanName
- Type:
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
status
- Type: typing.Optional[typing.Literal['All', 'Closed', 'Open']]
GetFindingsRequestPaginate
scanName
- Type:
- Required: Yes
status
- Type: typing.Optional[typing.Literal['All', 'Closed', 'Open']]
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.PaginatorConfig]
GetFindingsResponse
findings
- Type: typing.List[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.Finding]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
GetMetricsSummaryRequest
date
- Type: typing.Union[datetime.datetime, str]
- Required: Yes
GetMetricsSummaryResponse
metricsSummary
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
GetScanRequest
scanName
- Type:
- Required: Yes
runId
- Type: typing.Optional[str]
GetScanResponse
analysisType
- Type: typing.Literal['All', 'Security']
- Required: Yes
createdAt
- Type:
- Required: Yes
errorMessage
- Type:
- Required: Yes
numberOfRevisions
- Type:
- Required: Yes
runId
- Type:
- Required: Yes
scanName
- Type:
- Required: Yes
scanNameArn
- Type:
- Required: Yes
scanState
- Type: typing.Literal['Failed', 'InProgress', 'Successful']
- Required: Yes
updatedAt
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
ListFindingsMetricsRequest
endDate
- Type: typing.Union[datetime.datetime, str]
- Required: Yes
startDate
- Type: typing.Union[datetime.datetime, str]
- Required: Yes
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
ListFindingsMetricsRequestPaginate
endDate
- Type: typing.Union[datetime.datetime, str]
- Required: Yes
startDate
- Type: typing.Union[datetime.datetime, str]
- Required: Yes
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.PaginatorConfig]
ListFindingsMetricsResponse
findingsMetrics
- Type: typing.List[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.AccountFindingsMetric]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
ListScansRequest
maxResults
- Type: typing.Optional[int]
nextToken
- Type: typing.Optional[str]
ListScansRequestPaginate
PaginationConfig
- Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.PaginatorConfig]
ListScansResponse
summaries
- Type: typing.List[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.ScanSummary]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
nextToken
- Type: typing.Optional[str]
ListTagsForResourceRequest
resourceArn
- Type:
- Required: Yes
ListTagsForResourceResponse
tags
- Type: typing.Dict[str, str]
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
MetricsSummary
categoriesWithMostFindings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.CategoryWithFindingNum]]
date
- Type: typing.Optional[datetime.datetime]
openFindings
- Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.FindingMetricsValuePerSeverity]
scansWithMostOpenCriticalFindings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.ScanNameWithFindingNum]]
scansWithMostOpenFindings
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.ScanNameWithFindingNum]]
PaginatorConfig
MaxItems
- Type: typing.Optional[int]
PageSize
- Type: typing.Optional[int]
StartingToken
- Type: typing.Optional[str]
Recommendation
text
- Type: typing.Optional[str]
url
- Type: typing.Optional[str]
Remediation
recommendation
- Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.Recommendation]
suggestedFixes
- Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.SuggestedFix]]
Resource
id
- Type: typing.Optional[str]
subResourceId
- Type: typing.Optional[str]
ResourceId
codeArtifactId
- Type: typing.Optional[str]
ResponseMetadata
RequestId
- Type:
- Required: Yes
HTTPStatusCode
- Type:
- Required: Yes
HTTPHeaders
- Type: typing.Dict[str, str]
- Required: Yes
RetryAttempts
- Type:
- Required: Yes
HostId
- Type: typing.Optional[str]
ScanNameWithFindingNum
findingNumber
- Type: typing.Optional[int]
scanName
- Type: typing.Optional[str]
ScanSummary
createdAt
- Type:
- Required: Yes
runId
- Type:
- Required: Yes
scanName
- Type:
- Required: Yes
scanState
- Type: typing.Literal['Failed', 'InProgress', 'Successful']
- Required: Yes
scanNameArn
- Type: typing.Optional[str]
updatedAt
- Type: typing.Optional[datetime.datetime]
SuggestedFix
code
- Type: typing.Optional[str]
description
- Type: typing.Optional[str]
TagResourceRequest
resourceArn
- Type:
- Required: Yes
tags
- Type: typing.Dict[str, str]
- Required: Yes
UntagResourceRequest
resourceArn
- Type:
- Required: Yes
tagKeys
- Type: typing.List[str]
- Required: Yes
UpdateAccountConfigurationRequest
encryptionConfig
- Type:
- Required: Yes
UpdateAccountConfigurationResponse
encryptionConfig
- Type:
- Required: Yes
ResponseMetadata
- Type:
- Required: Yes
Vulnerability
filePath
- Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security.codeguru_security_classes.FilePath]
id
- Type: typing.Optional[str]
itemCount
- Type: typing.Optional[int]
referenceUrls
- Type: typing.Optional[typing.List[str]]
relatedVulnerabilities
- Type: typing.Optional[typing.List[str]]