Skip to content

Type definitions#

Index > CodeGuruSecurity > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef Union usage example

from mypy_boto3_codeguru_security.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime.datetime,
    str,
]

FindingMetricsValuePerSeverityTypeDef#

# FindingMetricsValuePerSeverityTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import FindingMetricsValuePerSeverityTypeDef


def get_value() -> FindingMetricsValuePerSeverityTypeDef:
    return {
        "critical": ...,
    }


# FindingMetricsValuePerSeverityTypeDef definition

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

BatchGetFindingsErrorTypeDef#

# BatchGetFindingsErrorTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import BatchGetFindingsErrorTypeDef


def get_value() -> BatchGetFindingsErrorTypeDef:
    return {
        "errorCode": ...,
    }


# BatchGetFindingsErrorTypeDef definition

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

FindingIdentifierTypeDef#

# FindingIdentifierTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import FindingIdentifierTypeDef


def get_value() -> FindingIdentifierTypeDef:
    return {
        "findingId": ...,
    }


# FindingIdentifierTypeDef definition

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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

CategoryWithFindingNumTypeDef#

# CategoryWithFindingNumTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import CategoryWithFindingNumTypeDef


def get_value() -> CategoryWithFindingNumTypeDef:
    return {
        "categoryName": ...,
    }


# CategoryWithFindingNumTypeDef definition

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

CodeLineTypeDef#

# CodeLineTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import CodeLineTypeDef


def get_value() -> CodeLineTypeDef:
    return {
        "content": ...,
    }


# CodeLineTypeDef definition

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

ResourceIdTypeDef#

# ResourceIdTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import ResourceIdTypeDef


def get_value() -> ResourceIdTypeDef:
    return {
        "codeArtifactId": ...,
    }


# ResourceIdTypeDef definition

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

CreateUploadUrlRequestTypeDef#

# CreateUploadUrlRequestTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import CreateUploadUrlRequestTypeDef


def get_value() -> CreateUploadUrlRequestTypeDef:
    return {
        "scanName": ...,
    }


# CreateUploadUrlRequestTypeDef definition

class CreateUploadUrlRequestTypeDef(TypedDict):
    scanName: str,

EncryptionConfigTypeDef#

# EncryptionConfigTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import EncryptionConfigTypeDef


def get_value() -> EncryptionConfigTypeDef:
    return {
        "kmsKeyArn": ...,
    }


# EncryptionConfigTypeDef definition

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

ResourceTypeDef#

# ResourceTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import ResourceTypeDef


def get_value() -> ResourceTypeDef:
    return {
        "id": ...,
    }


# ResourceTypeDef definition

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

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

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

GetFindingsRequestTypeDef#

# GetFindingsRequestTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import GetFindingsRequestTypeDef


def get_value() -> GetFindingsRequestTypeDef:
    return {
        "scanName": ...,
    }


# GetFindingsRequestTypeDef definition

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

GetScanRequestTypeDef#

# GetScanRequestTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import GetScanRequestTypeDef


def get_value() -> GetScanRequestTypeDef:
    return {
        "scanName": ...,
    }


# GetScanRequestTypeDef definition

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

ListScansRequestTypeDef#

# ListScansRequestTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import ListScansRequestTypeDef


def get_value() -> ListScansRequestTypeDef:
    return {
        "maxResults": ...,
    }


# ListScansRequestTypeDef definition

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

ScanSummaryTypeDef#

# ScanSummaryTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import ScanSummaryTypeDef


def get_value() -> ScanSummaryTypeDef:
    return {
        "createdAt": ...,
    }


# ScanSummaryTypeDef definition

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

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    resourceArn: str,

ScanNameWithFindingNumTypeDef#

# ScanNameWithFindingNumTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import ScanNameWithFindingNumTypeDef


def get_value() -> ScanNameWithFindingNumTypeDef:
    return {
        "findingNumber": ...,
    }


# ScanNameWithFindingNumTypeDef definition

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

RecommendationTypeDef#

# RecommendationTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import RecommendationTypeDef


def get_value() -> RecommendationTypeDef:
    return {
        "text": ...,
    }


# RecommendationTypeDef definition

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

SuggestedFixTypeDef#

# SuggestedFixTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import SuggestedFixTypeDef


def get_value() -> SuggestedFixTypeDef:
    return {
        "code": ...,
    }


# SuggestedFixTypeDef definition

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

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# TagResourceRequestTypeDef definition

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

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# UntagResourceRequestTypeDef definition

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

AccountFindingsMetricTypeDef#

# AccountFindingsMetricTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import AccountFindingsMetricTypeDef


def get_value() -> AccountFindingsMetricTypeDef:
    return {
        "closedFindings": ...,
    }


# AccountFindingsMetricTypeDef definition

class AccountFindingsMetricTypeDef(TypedDict):
    closedFindings: NotRequired[FindingMetricsValuePerSeverityTypeDef],  # (1)
    date: NotRequired[datetime.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

BatchGetFindingsRequestTypeDef#

# BatchGetFindingsRequestTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import BatchGetFindingsRequestTypeDef


def get_value() -> BatchGetFindingsRequestTypeDef:
    return {
        "findingIdentifiers": ...,
    }


# BatchGetFindingsRequestTypeDef definition

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

CreateUploadUrlResponseTypeDef#

# CreateUploadUrlResponseTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import CreateUploadUrlResponseTypeDef


def get_value() -> CreateUploadUrlResponseTypeDef:
    return {
        "codeArtifactId": ...,
    }


# CreateUploadUrlResponseTypeDef definition

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

GetScanResponseTypeDef#

# GetScanResponseTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import GetScanResponseTypeDef


def get_value() -> GetScanResponseTypeDef:
    return {
        "analysisType": ...,
    }


# GetScanResponseTypeDef definition

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

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

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

FilePathTypeDef#

# FilePathTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import FilePathTypeDef


def get_value() -> FilePathTypeDef:
    return {
        "codeSnippet": ...,
    }


# FilePathTypeDef definition

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

CreateScanRequestTypeDef#

# CreateScanRequestTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import CreateScanRequestTypeDef


def get_value() -> CreateScanRequestTypeDef:
    return {
        "resourceId": ...,
    }


# CreateScanRequestTypeDef definition

class CreateScanRequestTypeDef(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 TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import CreateScanResponseTypeDef


def get_value() -> CreateScanResponseTypeDef:
    return {
        "resourceId": ...,
    }


# 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 TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import GetAccountConfigurationResponseTypeDef


def get_value() -> GetAccountConfigurationResponseTypeDef:
    return {
        "encryptionConfig": ...,
    }


# GetAccountConfigurationResponseTypeDef definition

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

UpdateAccountConfigurationRequestTypeDef#

# UpdateAccountConfigurationRequestTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import UpdateAccountConfigurationRequestTypeDef


def get_value() -> UpdateAccountConfigurationRequestTypeDef:
    return {
        "encryptionConfig": ...,
    }


# UpdateAccountConfigurationRequestTypeDef definition

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

UpdateAccountConfigurationResponseTypeDef#

# UpdateAccountConfigurationResponseTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import UpdateAccountConfigurationResponseTypeDef


def get_value() -> UpdateAccountConfigurationResponseTypeDef:
    return {
        "encryptionConfig": ...,
    }


# UpdateAccountConfigurationResponseTypeDef definition

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

GetFindingsRequestPaginateTypeDef#

# GetFindingsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import GetFindingsRequestPaginateTypeDef


def get_value() -> GetFindingsRequestPaginateTypeDef:
    return {
        "scanName": ...,
    }


# GetFindingsRequestPaginateTypeDef definition

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

ListScansRequestPaginateTypeDef#

# ListScansRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import ListScansRequestPaginateTypeDef


def get_value() -> ListScansRequestPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }


# ListScansRequestPaginateTypeDef definition

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

GetMetricsSummaryRequestTypeDef#

# GetMetricsSummaryRequestTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import GetMetricsSummaryRequestTypeDef


def get_value() -> GetMetricsSummaryRequestTypeDef:
    return {
        "date": ...,
    }


# GetMetricsSummaryRequestTypeDef definition

class GetMetricsSummaryRequestTypeDef(TypedDict):
    date: TimestampTypeDef,

ListFindingsMetricsRequestPaginateTypeDef#

# ListFindingsMetricsRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import ListFindingsMetricsRequestPaginateTypeDef


def get_value() -> ListFindingsMetricsRequestPaginateTypeDef:
    return {
        "endDate": ...,
    }


# ListFindingsMetricsRequestPaginateTypeDef definition

class ListFindingsMetricsRequestPaginateTypeDef(TypedDict):
    endDate: TimestampTypeDef,
    startDate: TimestampTypeDef,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListFindingsMetricsRequestTypeDef#

# ListFindingsMetricsRequestTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import ListFindingsMetricsRequestTypeDef


def get_value() -> ListFindingsMetricsRequestTypeDef:
    return {
        "endDate": ...,
    }


# ListFindingsMetricsRequestTypeDef definition

class ListFindingsMetricsRequestTypeDef(TypedDict):
    endDate: TimestampTypeDef,
    startDate: TimestampTypeDef,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListScansResponseTypeDef#

# ListScansResponseTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import ListScansResponseTypeDef


def get_value() -> ListScansResponseTypeDef:
    return {
        "nextToken": ...,
    }


# ListScansResponseTypeDef definition

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

MetricsSummaryTypeDef#

# MetricsSummaryTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import MetricsSummaryTypeDef


def get_value() -> MetricsSummaryTypeDef:
    return {
        "categoriesWithMostFindings": ...,
    }


# MetricsSummaryTypeDef definition

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

RemediationTypeDef#

# RemediationTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import RemediationTypeDef


def get_value() -> RemediationTypeDef:
    return {
        "recommendation": ...,
    }


# RemediationTypeDef definition

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

ListFindingsMetricsResponseTypeDef#

# ListFindingsMetricsResponseTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import ListFindingsMetricsResponseTypeDef


def get_value() -> ListFindingsMetricsResponseTypeDef:
    return {
        "findingsMetrics": ...,
    }


# ListFindingsMetricsResponseTypeDef definition

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

VulnerabilityTypeDef#

# VulnerabilityTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import VulnerabilityTypeDef


def get_value() -> VulnerabilityTypeDef:
    return {
        "filePath": ...,
    }


# 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 TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import GetMetricsSummaryResponseTypeDef


def get_value() -> GetMetricsSummaryResponseTypeDef:
    return {
        "metricsSummary": ...,
    }


# GetMetricsSummaryResponseTypeDef definition

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

FindingTypeDef#

# FindingTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import FindingTypeDef


def get_value() -> FindingTypeDef:
    return {
        "createdAt": ...,
    }


# FindingTypeDef definition

class FindingTypeDef(TypedDict):
    createdAt: NotRequired[datetime.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.datetime],
    vulnerability: NotRequired[VulnerabilityTypeDef],  # (5)
  1. See RemediationTypeDef
  2. See ResourceTypeDef
  3. See SeverityType
  4. See StatusType
  5. See VulnerabilityTypeDef

BatchGetFindingsResponseTypeDef#

# BatchGetFindingsResponseTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import BatchGetFindingsResponseTypeDef


def get_value() -> BatchGetFindingsResponseTypeDef:
    return {
        "failedFindings": ...,
    }


# BatchGetFindingsResponseTypeDef definition

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

GetFindingsResponseTypeDef#

# GetFindingsResponseTypeDef TypedDict usage example

from mypy_boto3_codeguru_security.type_defs import GetFindingsResponseTypeDef


def get_value() -> GetFindingsResponseTypeDef:
    return {
        "findings": ...,
    }


# GetFindingsResponseTypeDef definition

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