Skip to content

Type definitions#

Index > CodeGuruSecurity > Type definitions

Auto-generated documentation for CodeGuruSecurity type annotations stubs module mypy-boto3-codeguru-security.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

FindingMetricsValuePerSeverityTypeDef#

# FindingMetricsValuePerSeverityTypeDef definition

class FindingMetricsValuePerSeverityTypeDef(TypedDict):
    critical: NotRequired[float],
    high: NotRequired[float],
    info: NotRequired[float],
    low: NotRequired[float],
    medium: NotRequired[float],

BatchGetFindingsErrorTypeDef#

# BatchGetFindingsErrorTypeDef definition

class BatchGetFindingsErrorTypeDef(TypedDict):
    errorCode: ErrorCodeType,  # (1)
    findingId: str,
    message: str,
    scanName: str,
  1. See ErrorCodeType

FindingIdentifierTypeDef#

# FindingIdentifierTypeDef definition

class FindingIdentifierTypeDef(TypedDict):
    findingId: str,
    scanName: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

CategoryWithFindingNumTypeDef#

# CategoryWithFindingNumTypeDef definition

class CategoryWithFindingNumTypeDef(TypedDict):
    categoryName: NotRequired[str],
    findingNumber: NotRequired[int],

CodeLineTypeDef#

# CodeLineTypeDef definition

class CodeLineTypeDef(TypedDict):
    content: NotRequired[str],
    number: NotRequired[int],

ResourceIdTypeDef#

# ResourceIdTypeDef definition

class ResourceIdTypeDef(TypedDict):
    codeArtifactId: NotRequired[str],

CreateUploadUrlRequestRequestTypeDef#

# CreateUploadUrlRequestRequestTypeDef definition

class CreateUploadUrlRequestRequestTypeDef(TypedDict):
    scanName: str,

EncryptionConfigTypeDef#

# EncryptionConfigTypeDef definition

class EncryptionConfigTypeDef(TypedDict):
    kmsKeyArn: NotRequired[str],

ResourceTypeDef#

# ResourceTypeDef definition

class ResourceTypeDef(TypedDict):
    id: NotRequired[str],
    subResourceId: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

GetFindingsRequestRequestTypeDef#

# GetFindingsRequestRequestTypeDef definition

class GetFindingsRequestRequestTypeDef(TypedDict):
    scanName: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],
    status: NotRequired[StatusType],  # (1)
  1. See StatusType

GetScanRequestRequestTypeDef#

# GetScanRequestRequestTypeDef definition

class GetScanRequestRequestTypeDef(TypedDict):
    scanName: str,
    runId: NotRequired[str],

ListScansRequestRequestTypeDef#

# ListScansRequestRequestTypeDef definition

class ListScansRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ScanSummaryTypeDef#

# ScanSummaryTypeDef definition

class ScanSummaryTypeDef(TypedDict):
    createdAt: datetime,
    runId: str,
    scanName: str,
    scanState: ScanStateType,  # (1)
    scanNameArn: NotRequired[str],
    updatedAt: NotRequired[datetime],
  1. See ScanStateType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ScanNameWithFindingNumTypeDef#

# ScanNameWithFindingNumTypeDef definition

class ScanNameWithFindingNumTypeDef(TypedDict):
    findingNumber: NotRequired[int],
    scanName: NotRequired[str],

RecommendationTypeDef#

# RecommendationTypeDef definition

class RecommendationTypeDef(TypedDict):
    text: NotRequired[str],
    url: NotRequired[str],

SuggestedFixTypeDef#

# SuggestedFixTypeDef definition

class SuggestedFixTypeDef(TypedDict):
    code: NotRequired[str],
    description: NotRequired[str],

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

AccountFindingsMetricTypeDef#

# AccountFindingsMetricTypeDef definition

class AccountFindingsMetricTypeDef(TypedDict):
    closedFindings: NotRequired[FindingMetricsValuePerSeverityTypeDef],  # (1)
    date: NotRequired[datetime],
    meanTimeToClose: NotRequired[FindingMetricsValuePerSeverityTypeDef],  # (1)
    newFindings: NotRequired[FindingMetricsValuePerSeverityTypeDef],  # (1)
    openFindings: NotRequired[FindingMetricsValuePerSeverityTypeDef],  # (1)
  1. See FindingMetricsValuePerSeverityTypeDef
  2. See FindingMetricsValuePerSeverityTypeDef
  3. See FindingMetricsValuePerSeverityTypeDef
  4. See FindingMetricsValuePerSeverityTypeDef

BatchGetFindingsRequestRequestTypeDef#

# BatchGetFindingsRequestRequestTypeDef definition

class BatchGetFindingsRequestRequestTypeDef(TypedDict):
    findingIdentifiers: Sequence[FindingIdentifierTypeDef],  # (1)
  1. See FindingIdentifierTypeDef

CreateUploadUrlResponseTypeDef#

# CreateUploadUrlResponseTypeDef definition

class CreateUploadUrlResponseTypeDef(TypedDict):
    codeArtifactId: str,
    requestHeaders: Dict[str, str],
    s3Url: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetScanResponseTypeDef#

# GetScanResponseTypeDef definition

class GetScanResponseTypeDef(TypedDict):
    analysisType: AnalysisTypeType,  # (1)
    createdAt: datetime,
    numberOfRevisions: int,
    runId: str,
    scanName: str,
    scanNameArn: str,
    scanState: ScanStateType,  # (2)
    updatedAt: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See AnalysisTypeType
  2. See ScanStateType
  3. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

FilePathTypeDef#

# FilePathTypeDef definition

class FilePathTypeDef(TypedDict):
    codeSnippet: NotRequired[List[CodeLineTypeDef]],  # (1)
    endLine: NotRequired[int],
    name: NotRequired[str],
    path: NotRequired[str],
    startLine: NotRequired[int],
  1. See CodeLineTypeDef

CreateScanRequestRequestTypeDef#

# CreateScanRequestRequestTypeDef definition

class CreateScanRequestRequestTypeDef(TypedDict):
    resourceId: ResourceIdTypeDef,  # (1)
    scanName: str,
    analysisType: NotRequired[AnalysisTypeType],  # (2)
    clientToken: NotRequired[str],
    scanType: NotRequired[ScanTypeType],  # (3)
    tags: NotRequired[Mapping[str, str]],
  1. See ResourceIdTypeDef
  2. See AnalysisTypeType
  3. See ScanTypeType

CreateScanResponseTypeDef#

# CreateScanResponseTypeDef definition

class CreateScanResponseTypeDef(TypedDict):
    resourceId: ResourceIdTypeDef,  # (1)
    runId: str,
    scanName: str,
    scanNameArn: str,
    scanState: ScanStateType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See ResourceIdTypeDef
  2. See ScanStateType
  3. See ResponseMetadataTypeDef

GetAccountConfigurationResponseTypeDef#

# GetAccountConfigurationResponseTypeDef definition

class GetAccountConfigurationResponseTypeDef(TypedDict):
    encryptionConfig: EncryptionConfigTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EncryptionConfigTypeDef
  2. See ResponseMetadataTypeDef

UpdateAccountConfigurationRequestRequestTypeDef#

# UpdateAccountConfigurationRequestRequestTypeDef definition

class UpdateAccountConfigurationRequestRequestTypeDef(TypedDict):
    encryptionConfig: EncryptionConfigTypeDef,  # (1)
  1. See EncryptionConfigTypeDef

UpdateAccountConfigurationResponseTypeDef#

# UpdateAccountConfigurationResponseTypeDef definition

class UpdateAccountConfigurationResponseTypeDef(TypedDict):
    encryptionConfig: EncryptionConfigTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EncryptionConfigTypeDef
  2. See ResponseMetadataTypeDef

GetFindingsRequestGetFindingsPaginateTypeDef#

# GetFindingsRequestGetFindingsPaginateTypeDef definition

class GetFindingsRequestGetFindingsPaginateTypeDef(TypedDict):
    scanName: str,
    status: NotRequired[StatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See StatusType
  2. See PaginatorConfigTypeDef

ListScansRequestListScansPaginateTypeDef#

# ListScansRequestListScansPaginateTypeDef definition

class ListScansRequestListScansPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

GetMetricsSummaryRequestRequestTypeDef#

# GetMetricsSummaryRequestRequestTypeDef definition

class GetMetricsSummaryRequestRequestTypeDef(TypedDict):
    date: Union[datetime, str],

ListFindingsMetricsRequestListFindingsMetricsPaginateTypeDef#

# ListFindingsMetricsRequestListFindingsMetricsPaginateTypeDef definition

class ListFindingsMetricsRequestListFindingsMetricsPaginateTypeDef(TypedDict):
    endDate: Union[datetime, str],
    startDate: Union[datetime, str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListFindingsMetricsRequestRequestTypeDef#

# ListFindingsMetricsRequestRequestTypeDef definition

class ListFindingsMetricsRequestRequestTypeDef(TypedDict):
    endDate: Union[datetime, str],
    startDate: Union[datetime, str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListScansResponseTypeDef#

# ListScansResponseTypeDef definition

class ListScansResponseTypeDef(TypedDict):
    nextToken: str,
    summaries: List[ScanSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ScanSummaryTypeDef
  2. See ResponseMetadataTypeDef

MetricsSummaryTypeDef#

# MetricsSummaryTypeDef definition

class MetricsSummaryTypeDef(TypedDict):
    categoriesWithMostFindings: NotRequired[List[CategoryWithFindingNumTypeDef]],  # (1)
    date: NotRequired[datetime],
    openFindings: NotRequired[FindingMetricsValuePerSeverityTypeDef],  # (2)
    scansWithMostOpenCriticalFindings: NotRequired[List[ScanNameWithFindingNumTypeDef]],  # (3)
    scansWithMostOpenFindings: NotRequired[List[ScanNameWithFindingNumTypeDef]],  # (3)
  1. See CategoryWithFindingNumTypeDef
  2. See FindingMetricsValuePerSeverityTypeDef
  3. See ScanNameWithFindingNumTypeDef
  4. See ScanNameWithFindingNumTypeDef

RemediationTypeDef#

# RemediationTypeDef definition

class RemediationTypeDef(TypedDict):
    recommendation: NotRequired[RecommendationTypeDef],  # (1)
    suggestedFixes: NotRequired[List[SuggestedFixTypeDef]],  # (2)
  1. See RecommendationTypeDef
  2. See SuggestedFixTypeDef

ListFindingsMetricsResponseTypeDef#

# ListFindingsMetricsResponseTypeDef definition

class ListFindingsMetricsResponseTypeDef(TypedDict):
    findingsMetrics: List[AccountFindingsMetricTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AccountFindingsMetricTypeDef
  2. See ResponseMetadataTypeDef

VulnerabilityTypeDef#

# VulnerabilityTypeDef definition

class VulnerabilityTypeDef(TypedDict):
    filePath: NotRequired[FilePathTypeDef],  # (1)
    id: NotRequired[str],
    itemCount: NotRequired[int],
    referenceUrls: NotRequired[List[str]],
    relatedVulnerabilities: NotRequired[List[str]],
  1. See FilePathTypeDef

GetMetricsSummaryResponseTypeDef#

# GetMetricsSummaryResponseTypeDef definition

class GetMetricsSummaryResponseTypeDef(TypedDict):
    metricsSummary: MetricsSummaryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MetricsSummaryTypeDef
  2. See ResponseMetadataTypeDef

FindingTypeDef#

# FindingTypeDef definition

class FindingTypeDef(TypedDict):
    createdAt: NotRequired[datetime],
    description: NotRequired[str],
    detectorId: NotRequired[str],
    detectorName: NotRequired[str],
    detectorTags: NotRequired[List[str]],
    generatorId: NotRequired[str],
    id: NotRequired[str],
    remediation: NotRequired[RemediationTypeDef],  # (1)
    resource: NotRequired[ResourceTypeDef],  # (2)
    ruleId: NotRequired[str],
    severity: NotRequired[SeverityType],  # (3)
    status: NotRequired[StatusType],  # (4)
    title: NotRequired[str],
    type: NotRequired[str],
    updatedAt: NotRequired[datetime],
    vulnerability: NotRequired[VulnerabilityTypeDef],  # (5)
  1. See RemediationTypeDef
  2. See ResourceTypeDef
  3. See SeverityType
  4. See StatusType
  5. See VulnerabilityTypeDef

BatchGetFindingsResponseTypeDef#

# BatchGetFindingsResponseTypeDef definition

class BatchGetFindingsResponseTypeDef(TypedDict):
    failedFindings: List[BatchGetFindingsErrorTypeDef],  # (1)
    findings: List[FindingTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See BatchGetFindingsErrorTypeDef
  2. See FindingTypeDef
  3. See ResponseMetadataTypeDef

GetFindingsResponseTypeDef#

# GetFindingsResponseTypeDef definition

class GetFindingsResponseTypeDef(TypedDict):
    findings: List[FindingTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FindingTypeDef
  2. See ResponseMetadataTypeDef