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

***************
get_sbom_export
***************



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

  

  Gets details of a software bill of materials (SBOM) report.

  

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


  **Request Syntax**
  ::

    response = client.get_sbom_export(
        reportId='string'
    )
    
  :type reportId: string
  :param reportId: **[REQUIRED]** 

    The report ID of the SBOM export to get details for.

    

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

    
    ::

      {
          'reportId': 'string',
          'format': 'CYCLONEDX_1_4'|'SPDX_2_3',
          'status': 'SUCCEEDED'|'IN_PROGRESS'|'CANCELLED'|'FAILED',
          'errorCode': 'INTERNAL_ERROR'|'INVALID_PERMISSIONS'|'NO_FINDINGS_FOUND'|'BUCKET_NOT_FOUND'|'INCOMPATIBLE_BUCKET_REGION'|'MALFORMED_KMS_KEY',
          'errorMessage': 'string',
          's3Destination': {
              'bucketName': 'string',
              'keyPrefix': 'string',
              'kmsKeyArn': 'string'
          },
          'filterCriteria': {
              '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'
                  },
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

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

        
      

      - **format** *(string) --* 

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

        
      

      - **status** *(string) --* 

        The status of the software bill of materials (SBOM) report.

        
      

      - **errorCode** *(string) --* 

        An error code.

        
      

      - **errorMessage** *(string) --* 

        An error message.

        
      

      - **s3Destination** *(dict) --* 

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

        
        

        - **bucketName** *(string) --* 

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

          
        

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

          The prefix that the findings will be written under.

          
        

        - **kmsKeyArn** *(string) --* 

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

          
    
      

      - **filterCriteria** *(dict) --* 

        Contains details about the resource filter criteria used 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) --* 

              The filter's comparison.

              
            

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

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

              The filter's comparison.

              
            

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

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

              The filter's comparison.

              
            

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

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

              The filter's comparison.

              
            

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

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

              The filter's comparison.

              
            

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

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

              The filter's comparison.

              
            

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

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

              The filter's comparison.

              
            

            - **key** *(string) --* 

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

              The filter's comparison.

              
            

            - **key** *(string) --* 

              The filter's key.

              
            

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

              The filter's value.

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

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

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

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

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

  