Inspector2 / Client / update_code_security_scan_configuration

update_code_security_scan_configuration

Inspector2.Client.update_code_security_scan_configuration(**kwargs)

Updates an existing code security scan configuration.

See also: AWS API Documentation

Request Syntax

response = client.update_code_security_scan_configuration(
    configuration={
        'continuousIntegrationScanConfiguration': {
            'supportedEvents': [
                'PULL_REQUEST'|'PUSH',
            ]
        },
        'periodicScanConfiguration': {
            'frequency': 'WEEKLY'|'MONTHLY'|'NEVER',
            'frequencyExpression': 'string'
        },
        'ruleSetCategories': [
            'SAST'|'IAC'|'SCA',
        ]
    },
    scanConfigurationArn='string'
)
Parameters:

  • configuration (dict) –

    [REQUIRED]

    The updated configuration settings for the code security scan.

    • continuousIntegrationScanConfiguration (dict) –

      Configuration settings for continuous integration scans that run automatically when code changes are made.

      • supportedEvents (list) – [REQUIRED]

        The repository events that trigger continuous integration scans, such as pull requests or commits.

        • (string) –

    • periodicScanConfiguration (dict) –

      Configuration settings for periodic scans that run on a scheduled basis.

      • frequency (string) –

        The frequency at which periodic scans are performed (such as weekly or monthly).

        If you don’t provide the frequencyExpression Amazon Inspector chooses day for the scan to run. If you provide the frequencyExpression, the schedule must match the specified frequency.

      • frequencyExpression (string) –

        The schedule expression for periodic scans, in cron format.

    • ruleSetCategories (list) – [REQUIRED]

      The categories of security rules to be applied during the scan.

      • (string) –

  • scanConfigurationArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the scan configuration to update.

Return type:

dict

Returns:

Response Syntax

{
    'scanConfigurationArn': 'string'
}

Response Structure

  • (dict) –

    • scanConfigurationArn (string) –

      The Amazon Resource Name (ARN) of the updated scan configuration.

Exceptions