Skip to content

CreateScanRequest

Source code in docs_src/capo_codeguru_security/types/create_scan_request.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
class CreateScanRequest(TypedDict, closed=True):
    client_token: NotRequired["capo_codeguru_security.types.client_token.ClientToken"]
    """<p>The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.</p>"""
    resource_id: "capo_codeguru_security.types.resource_id.ResourceId"
    """<p>The identifier for the resource object to be scanned.</p>"""
    scan_name: "capo_codeguru_security.types.scan_name.ScanName"
    """<p>The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a <code>STANDARD</code> scan type. </p>"""
    scan_type: NotRequired["capo_codeguru_security.types.scan_type.ScanType"]
    """<p>The type of scan, either <code>Standard</code> or <code>Express</code>. Defaults to <code>Standard</code> type if missing.</p> <p> <code>Express</code> scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. <code>Standard</code> scans have standard resource limits and use the full set of detectors to analyze your code.</p>"""
    analysis_type: NotRequired[
        "capo_codeguru_security.types.analysis_type.AnalysisType"
    ]
    """<p>The type of analysis you want CodeGuru Security to perform 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. Defaults to <code>Security</code> type if missing.</p>"""
    tags: NotRequired["capo_codeguru_security.types.tag_map.TagMap"]
    """<p>An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:</p> <ul> <li> <p>A tag key. For example, <code>CostCenter</code>, <code>Environment</code>, or <code>Secret</code>. Tag keys are case sensitive.</p> </li> <li> <p>An optional tag value field. For example, <code>111122223333</code>, <code>Production</code>, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.</p> </li> </ul>"""

analysis_type instance-attribute 

analysis_type: NotRequired[AnalysisType]

The type of analysis you want CodeGuru Security to perform 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. Defaults to Security type if missing.

client_token instance-attribute 

client_token: NotRequired[ClientToken]

The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.

resource_id instance-attribute 

resource_id: ResourceId

The identifier for the resource object to be scanned.

scan_name instance-attribute 

scan_name: ScanName

The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a STANDARD scan type.

scan_type instance-attribute 

scan_type: NotRequired[ScanType]

The type of scan, either Standard or Express. Defaults to Standard type if missing.

Express scans run on limited resources and use a limited set of detectors to analyze your code in near-real time. Standard scans have standard resource limits and use the full set of detectors to analyze your code.

tags instance-attribute 

tags: NotRequired[TagMap]

An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:

  • A tag key. For example, CostCenter, Environment, or Secret. Tag keys are case sensitive.

  • An optional tag value field. For example, 111122223333, Production, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.