:doc:`Inspector2 <../../inspector2>` / Client / get_code_security_scan_configuration

************************************
get_code_security_scan_configuration
************************************



.. py:method:: Inspector2.Client.get_code_security_scan_configuration(**kwargs)

  

  Retrieves information about a code security scan configuration.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/inspector2-2020-06-08/GetCodeSecurityScanConfiguration>`_  


  **Request Syntax**
  ::

    response = client.get_code_security_scan_configuration(
        scanConfigurationArn='string'
    )
    
  :type scanConfigurationArn: string
  :param scanConfigurationArn: **[REQUIRED]** 

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

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'scanConfigurationArn': 'string',
          'name': 'string',
          'configuration': {
              'periodicScanConfiguration': {
                  'frequency': 'WEEKLY'|'MONTHLY'|'NEVER',
                  'frequencyExpression': 'string'
              },
              'continuousIntegrationScanConfiguration': {
                  'supportedEvents': [
                      'PULL_REQUEST'|'PUSH',
                  ]
              },
              'ruleSetCategories': [
                  'SAST'|'IAC'|'SCA',
              ]
          },
          'level': 'ORGANIZATION'|'ACCOUNT',
          'scopeSettings': {
              'projectSelectionScope': 'ALL'
          },
          'createdAt': datetime(2015, 1, 1),
          'lastUpdatedAt': datetime(2015, 1, 1),
          'tags': {
              'string': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **scanConfigurationArn** *(string) --* 

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

        
      

      - **name** *(string) --* 

        The name of the scan configuration.

        
      

      - **configuration** *(dict) --* 

        The configuration settings for the code security scan.

        
        

        - **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.

            
      
        

        - **continuousIntegrationScanConfiguration** *(dict) --* 

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

          
          

          - **supportedEvents** *(list) --* 

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

            
            

            - *(string) --* 
        
      
        

        - **ruleSetCategories** *(list) --* 

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

          
          

          - *(string) --* 
      
    
      

      - **level** *(string) --* 

        The security level for 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.

          
    
      

      - **createdAt** *(datetime) --* 

        The timestamp when the scan configuration was created.

        
      

      - **lastUpdatedAt** *(datetime) --* 

        The timestamp when the scan configuration was last updated.

        
      

      - **tags** *(dict) --* 

        The tags associated with the scan configuration.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
  
  **Exceptions**
  
  *   :py:class:`Inspector2.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`Inspector2.Client.exceptions.ValidationException`

  
  *   :py:class:`Inspector2.Client.exceptions.ThrottlingException`

  
  *   :py:class:`Inspector2.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`Inspector2.Client.exceptions.InternalServerException`

  