Skip to content

GetScanResponse

Source code in docs_src/capo_codeguru_security/types/get_scan_response.py
class GetScanResponse(TypedDict, closed=True):
    scan_name: "capo_codeguru_security.types.scan_name.ScanName"
    """<p>The name of the scan.</p>"""
    run_id: "capo_codeguru_security.types.uuid.Uuid"
    """<p>UUID that identifies the individual scan run.</p>"""
    scan_state: "capo_codeguru_security.types.scan_state.ScanState"
    """<p>The current state of the scan. Returns either <code>InProgress</code>, <code>Successful</code>, or <code>Failed</code>.</p>"""
    created_at: "datetime.datetime"
    """<p>The time the scan was created.</p>"""
    analysis_type: "capo_codeguru_security.types.analysis_type.AnalysisType"
    """<p>The type of analysis CodeGuru Security performed in the scan, either <code>Security</code> or <code>All</code>. The <code>Security</code> type only generates findings related to security. The <code>All</code> type generates both security findings and quality findings.</p>"""
    updated_at: NotRequired["datetime.datetime"]
    """<p>The time when the scan was last updated. Only available for <code>STANDARD</code> scan types.</p>"""
    number_of_revisions: NotRequired["int"]
    """<p>The number of times a scan has been re-run on a revised resource.</p>"""
    scan_name_arn: NotRequired["capo_codeguru_security.types.scan_name_arn.ScanNameArn"]
    """<p>The ARN for the scan name.</p>"""
    error_message: NotRequired[
        "capo_codeguru_security.types.error_message.ErrorMessage"
    ]
    """<p>Details about the error that causes a scan to fail to be retrieved.</p>"""

analysis_type instance-attribute

analysis_type: AnalysisType

The type of analysis CodeGuru Security performed in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings.

created_at instance-attribute

created_at: datetime

The time the scan was created.

error_message instance-attribute

error_message: NotRequired[ErrorMessage]

Details about the error that causes a scan to fail to be retrieved.

number_of_revisions instance-attribute

number_of_revisions: NotRequired[int]

The number of times a scan has been re-run on a revised resource.

run_id instance-attribute

run_id: Uuid

UUID that identifies the individual scan run.

scan_name instance-attribute

scan_name: ScanName

The name of the scan.

scan_name_arn instance-attribute

scan_name_arn: NotRequired[ScanNameArn]

The ARN for the scan name.

scan_state instance-attribute

scan_state: ScanState

The current state of the scan. Returns either InProgress, Successful, or Failed.

updated_at instance-attribute

updated_at: NotRequired[datetime]

The time when the scan was last updated. Only available for STANDARD scan types.