Inspector2 / Client / list_code_security_scan_configurations

list_code_security_scan_configurations

Inspector2.Client.list_code_security_scan_configurations(**kwargs)

Lists all code security scan configurations in your account.

See also: AWS API Documentation

Request Syntax

response = client.list_code_security_scan_configurations(
    maxResults=123,
    nextToken='string'
)

Parameters:

• maxResults (integer) – The maximum number of results to return in a single call.

• nextToken (string) – A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Return type:

dict

Returns:

Response Syntax

{
    'configurations': [
        {
            'continuousIntegrationScanSupportedEvents': [
                'PULL_REQUEST'|'PUSH',
            ],
            'frequencyExpression': 'string',
            'name': 'string',
            'ownerAccountId': 'string',
            'periodicScanFrequency': 'WEEKLY'|'MONTHLY'|'NEVER',
            'ruleSetCategories': [
                'SAST'|'IAC'|'SCA',
            ],
            'scanConfigurationArn': 'string',
            'scopeSettings': {
                'projectSelectionScope': 'ALL'
            },
            'tags': {
                'string': 'string'
            }
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • configurations (list) –

    A list of code security scan configuration summaries.

    • (dict) –

      A summary of information about a code security scan configuration.

      • continuousIntegrationScanSupportedEvents (list) –

        The repository events that trigger continuous integration scans.

        • (string) –

      • frequencyExpression (string) –

        The schedule expression for periodic scans, in cron format.

      • name (string) –

        The name of the scan configuration.

      • ownerAccountId (string) –

        The Amazon Web Services account ID that owns the scan configuration.

      • periodicScanFrequency (string) –

        The frequency at which periodic scans are performed.

      • ruleSetCategories (list) –

        The categories of security rules applied during the scan.

        • (string) –

      • scanConfigurationArn (string) –

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

      • scopeSettings (dict) –

        The scope settings that define which repositories will be scanned. If the ScopeSetting parameter is ALL the scan configuration applies to all existing and future projects imported into Amazon Inspector.

        • projectSelectionScope (string) –

          The scope of projects to be selected for scanning within the integrated repositories. Setting the value to ALL applies the scope settings to all existing and future projects imported into Amazon Inspector.

      • tags (dict) –

        The tags associated with the scan configuration.

        • (string) –

          • (string) –

  • nextToken (string) –

    A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request. For subsequent calls, use the NextToken value returned from the previous request to continue listing results after the first page.

Exceptions

• Inspector2.Client.exceptions.AccessDeniedException

• Inspector2.Client.exceptions.ValidationException

• Inspector2.Client.exceptions.ThrottlingException

• Inspector2.Client.exceptions.ResourceNotFoundException

• Inspector2.Client.exceptions.InternalServerException