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

******************
create_sbom_export
******************



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

  

  Creates a software bill of materials (SBOM) report.

  

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


  **Request Syntax**
  ::

    response = client.create_sbom_export(
        resourceFilterCriteria={
            'accountId': [
                {
                    'comparison': 'EQUALS'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'resourceId': [
                {
                    'comparison': 'EQUALS'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'resourceType': [
                {
                    'comparison': 'EQUALS'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'ecrRepositoryName': [
                {
                    'comparison': 'EQUALS'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'lambdaFunctionName': [
                {
                    'comparison': 'EQUALS'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'ecrImageTags': [
                {
                    'comparison': 'EQUALS'|'NOT_EQUALS',
                    'value': 'string'
                },
            ],
            'ec2InstanceTags': [
                {
                    'comparison': 'EQUALS',
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'lambdaFunctionTags': [
                {
                    'comparison': 'EQUALS',
                    'key': 'string',
                    'value': 'string'
                },
            ]
        },
        reportFormat='CYCLONEDX_1_4'|'SPDX_2_3',
        s3Destination={
            'bucketName': 'string',
            'keyPrefix': 'string',
            'kmsKeyArn': 'string'
        }
    )
    
  :type resourceFilterCriteria: dict
  :param resourceFilterCriteria: 

    The resource filter criteria for the software bill of materials (SBOM) report.

    

  
    - **accountId** *(list) --* 

      The account IDs used as resource filter criteria.

      

    
      - *(dict) --* 

        A resource string filter for a software bill of materials report.

        

      
        - **comparison** *(string) --* **[REQUIRED]** 

          The filter's comparison.

          

        
        - **value** *(string) --* **[REQUIRED]** 

          The filter's value.

          

        
      
  
    - **resourceId** *(list) --* 

      The resource IDs used as resource filter criteria.

      

    
      - *(dict) --* 

        A resource string filter for a software bill of materials report.

        

      
        - **comparison** *(string) --* **[REQUIRED]** 

          The filter's comparison.

          

        
        - **value** *(string) --* **[REQUIRED]** 

          The filter's value.

          

        
      
  
    - **resourceType** *(list) --* 

      The resource types used as resource filter criteria.

      

    
      - *(dict) --* 

        A resource string filter for a software bill of materials report.

        

      
        - **comparison** *(string) --* **[REQUIRED]** 

          The filter's comparison.

          

        
        - **value** *(string) --* **[REQUIRED]** 

          The filter's value.

          

        
      
  
    - **ecrRepositoryName** *(list) --* 

      The ECR repository names used as resource filter criteria.

      

    
      - *(dict) --* 

        A resource string filter for a software bill of materials report.

        

      
        - **comparison** *(string) --* **[REQUIRED]** 

          The filter's comparison.

          

        
        - **value** *(string) --* **[REQUIRED]** 

          The filter's value.

          

        
      
  
    - **lambdaFunctionName** *(list) --* 

      The Amazon Web Services Lambda function name used as resource filter criteria.

      

    
      - *(dict) --* 

        A resource string filter for a software bill of materials report.

        

      
        - **comparison** *(string) --* **[REQUIRED]** 

          The filter's comparison.

          

        
        - **value** *(string) --* **[REQUIRED]** 

          The filter's value.

          

        
      
  
    - **ecrImageTags** *(list) --* 

      The ECR image tags used as resource filter criteria.

      

    
      - *(dict) --* 

        A resource string filter for a software bill of materials report.

        

      
        - **comparison** *(string) --* **[REQUIRED]** 

          The filter's comparison.

          

        
        - **value** *(string) --* **[REQUIRED]** 

          The filter's value.

          

        
      
  
    - **ec2InstanceTags** *(list) --* 

      The EC2 instance tags used as resource filter criteria.

      

    
      - *(dict) --* 

        A resource map filter for a software bill of material report.

        

      
        - **comparison** *(string) --* **[REQUIRED]** 

          The filter's comparison.

          

        
        - **key** *(string) --* **[REQUIRED]** 

          The filter's key.

          

        
        - **value** *(string) --* 

          The filter's value.

          

        
      
  
    - **lambdaFunctionTags** *(list) --* 

      The Amazon Web Services Lambda function tags used as resource filter criteria.

      

    
      - *(dict) --* 

        A resource map filter for a software bill of material report.

        

      
        - **comparison** *(string) --* **[REQUIRED]** 

          The filter's comparison.

          

        
        - **key** *(string) --* **[REQUIRED]** 

          The filter's key.

          

        
        - **value** *(string) --* 

          The filter's value.

          

        
      
  
  
  :type reportFormat: string
  :param reportFormat: **[REQUIRED]** 

    The output format for the software bill of materials (SBOM) report.

    

  
  :type s3Destination: dict
  :param s3Destination: **[REQUIRED]** 

    Contains details of the Amazon S3 bucket and KMS key used to export findings.

    

  
    - **bucketName** *(string) --* **[REQUIRED]** 

      The name of the Amazon S3 bucket to export findings to.

      

    
    - **keyPrefix** *(string) --* 

      The prefix that the findings will be written under.

      

    
    - **kmsKeyArn** *(string) --* **[REQUIRED]** 

      The ARN of the KMS key used to encrypt data when exporting findings.

      

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

    
    ::

      {
          'reportId': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **reportId** *(string) --* 

        The report ID for the software bill of materials (SBOM) report.

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

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

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

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

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

  