Skip to content

Codeguru Security Classes

AccountFindingsMetricTypeDef

closedFindings

  • Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security_classes.FindingMetricsValuePerSeverityTypeDef]

date

  • Type: typing.Optional[datetime.datetime]

meanTimeToClose

  • Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security_classes.FindingMetricsValuePerSeverityTypeDef]

newFindings

  • Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security_classes.FindingMetricsValuePerSeverityTypeDef]

openFindings

  • Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security_classes.FindingMetricsValuePerSeverityTypeDef]

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

BatchGetFindingsErrorTypeDef

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

BatchGetFindingsRequestRequestTypeDef

findingIdentifiers

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.codeguru_security_classes.FindingIdentifierTypeDef]
  • Required: Yes

BatchGetFindingsResponseTypeDef

failedFindings

  • Type: typing.List[aws_resource_validator.pydantic_models.codeguru_security_classes.BatchGetFindingsErrorTypeDef]
  • Required: Yes

findings

  • Type: typing.List[aws_resource_validator.pydantic_models.codeguru_security_classes.FindingTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CategoryWithFindingNumTypeDef

categoryName

  • Type: typing.Optional[str]

findingNumber

  • Type: typing.Optional[int]

CodeLineTypeDef

content

  • Type: typing.Optional[str]

number

  • Type: typing.Optional[int]

CreateScanRequestRequestTypeDef

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.Mapping[str, str]]

CreateScanResponseTypeDef

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

CreateUploadUrlRequestRequestTypeDef

scanName

  • Type:
  • Required: Yes

CreateUploadUrlResponseTypeDef

codeArtifactId

  • Type:
  • Required: Yes

requestHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

s3Url

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

EncryptionConfigTypeDef

kmsKeyArn

  • Type: typing.Optional[str]

FilePathTypeDef

codeSnippet

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.codeguru_security_classes.CodeLineTypeDef]]

endLine

  • Type: typing.Optional[int]

name

  • Type: typing.Optional[str]

path

  • Type: typing.Optional[str]

startLine

  • Type: typing.Optional[int]

FindingIdentifierTypeDef

findingId

  • Type:
  • Required: Yes

scanName

  • Type:
  • Required: Yes

FindingMetricsValuePerSeverityTypeDef

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]

FindingTypeDef

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_classes.RemediationTypeDef]

resource

  • Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security_classes.ResourceTypeDef]

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_classes.VulnerabilityTypeDef]

GetAccountConfigurationResponseTypeDef

encryptionConfig

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetFindingsRequestGetFindingsPaginateTypeDef

scanName

  • Type:
  • Required: Yes

status

  • Type: typing.Optional[typing.Literal['All', 'Closed', 'Open']]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security_classes.PaginatorConfigTypeDef]

GetFindingsRequestRequestTypeDef

scanName

  • Type:
  • Required: Yes

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

status

  • Type: typing.Optional[typing.Literal['All', 'Closed', 'Open']]

GetFindingsResponseTypeDef

findings

  • Type: typing.List[aws_resource_validator.pydantic_models.codeguru_security_classes.FindingTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetMetricsSummaryRequestRequestTypeDef

date

  • Type: typing.Union[datetime.datetime, str]
  • Required: Yes

GetMetricsSummaryResponseTypeDef

metricsSummary

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetScanRequestRequestTypeDef

scanName

  • Type:
  • Required: Yes

runId

  • Type: typing.Optional[str]

GetScanResponseTypeDef

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

ListFindingsMetricsRequestListFindingsMetricsPaginateTypeDef

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_classes.PaginatorConfigTypeDef]

ListFindingsMetricsRequestRequestTypeDef

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]

ListFindingsMetricsResponseTypeDef

findingsMetrics

  • Type: typing.List[aws_resource_validator.pydantic_models.codeguru_security_classes.AccountFindingsMetricTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListScansRequestListScansPaginateTypeDef

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security_classes.PaginatorConfigTypeDef]

ListScansRequestRequestTypeDef

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListScansResponseTypeDef

nextToken

  • Type:
  • Required: Yes

summaries

  • Type: typing.List[aws_resource_validator.pydantic_models.codeguru_security_classes.ScanSummaryTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTagsForResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponseTypeDef

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

MetricsSummaryTypeDef

categoriesWithMostFindings

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.codeguru_security_classes.CategoryWithFindingNumTypeDef]]

date

  • Type: typing.Optional[datetime.datetime]

openFindings

  • Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security_classes.FindingMetricsValuePerSeverityTypeDef]

scansWithMostOpenCriticalFindings

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.codeguru_security_classes.ScanNameWithFindingNumTypeDef]]

scansWithMostOpenFindings

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.codeguru_security_classes.ScanNameWithFindingNumTypeDef]]

PaginatorConfigTypeDef

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

RecommendationTypeDef

text

  • Type: typing.Optional[str]

url

  • Type: typing.Optional[str]

RemediationTypeDef

recommendation

  • Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security_classes.RecommendationTypeDef]

suggestedFixes

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.codeguru_security_classes.SuggestedFixTypeDef]]

ResourceIdTypeDef

codeArtifactId

  • Type: typing.Optional[str]

ResourceTypeDef

id

  • Type: typing.Optional[str]

subResourceId

  • Type: typing.Optional[str]

ResponseMetadataTypeDef

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]

ScanNameWithFindingNumTypeDef

findingNumber

  • Type: typing.Optional[int]

scanName

  • Type: typing.Optional[str]

ScanSummaryTypeDef

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]

SuggestedFixTypeDef

code

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

TagResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.Mapping[str, str]
  • Required: Yes

UntagResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.Sequence[str]
  • Required: Yes

UpdateAccountConfigurationRequestRequestTypeDef

encryptionConfig

  • Type:
  • Required: Yes

UpdateAccountConfigurationResponseTypeDef

encryptionConfig

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

VulnerabilityTypeDef

filePath

  • Type: typing.Optional[aws_resource_validator.pydantic_models.codeguru_security_classes.FilePathTypeDef]

id

  • Type: typing.Optional[str]

itemCount

  • Type: typing.Optional[int]

referenceUrls

  • Type: typing.Optional[typing.List[str]]

relatedVulnerabilities

  • Type: typing.Optional[typing.List[str]]