Inspector2 / Client / start_code_security_scan

start_code_security_scan

Inspector2.Client.start_code_security_scan(**kwargs)

Initiates a code security scan on a specified repository.

See also: AWS API Documentation

Request Syntax

response = client.start_code_security_scan(
    clientToken='string',
    resource={
        'projectId': 'string'
    }
)
Parameters:

  • clientToken (string) –

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

    This field is autopopulated if not provided.

  • resource (dict) –

    [REQUIRED]

    The resource identifier for the code repository to scan.

    Note

    This is a Tagged Union structure. Only one of the following top level keys can be set: projectId.

    • projectId (string) –

      The unique identifier of the project in the code repository.

Return type:

dict

Returns:

Response Syntax

{
    'scanId': 'string',
    'status': 'IN_PROGRESS'|'SUCCESSFUL'|'FAILED'|'SKIPPED'
}

Response Structure

  • (dict) –

    • scanId (string) –

      The unique identifier of the initiated scan.

    • status (string) –

      The current status of the initiated scan.

Exceptions