:doc:`IoT <../../iot>` / Client / associate_sbom_with_package_version

***********************************
associate_sbom_with_package_version
***********************************



.. py:method:: IoT.Client.associate_sbom_with_package_version(**kwargs)

  

  Associates the selected software bill of materials (SBOM) with a specific software package version.

   

  Requires permission to access the `AssociateSbomWithPackageVersion <https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions>`__ action.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iot-2015-05-28/AssociateSbomWithPackageVersion>`_  


  **Request Syntax**
  ::

    response = client.associate_sbom_with_package_version(
        packageName='string',
        versionName='string',
        sbom={
            's3Location': {
                'bucket': 'string',
                'key': 'string',
                'version': 'string'
            }
        },
        clientToken='string'
    )
    
  :type packageName: string
  :param packageName: **[REQUIRED]** 

    The name of the new software package.

    

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

    The name of the new package version.

    

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

    A specific software bill of matrerials associated with a software package version.

    

  
    - **s3Location** *(dict) --* 

      The S3 location.

      

    
      - **bucket** *(string) --* 

        The S3 bucket.

        

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

        The S3 key.

        

      
      - **version** *(string) --* 

        The S3 bucket version.

        

      
    
  
  :type clientToken: string
  :param clientToken: 

    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

    This field is autopopulated if not provided.

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

    
    ::

      {
          'packageName': 'string',
          'versionName': 'string',
          'sbom': {
              's3Location': {
                  'bucket': 'string',
                  'key': 'string',
                  'version': 'string'
              }
          },
          'sbomValidationStatus': 'IN_PROGRESS'|'FAILED'|'SUCCEEDED'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **packageName** *(string) --* 

        The name of the new software package.

        
      

      - **versionName** *(string) --* 

        The name of the new package version.

        
      

      - **sbom** *(dict) --* 

        A specific software bill of matrerials associated with a software package version.

        
        

        - **s3Location** *(dict) --* 

          The S3 location.

          
          

          - **bucket** *(string) --* 

            The S3 bucket.

            
          

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

            The S3 key.

            
          

          - **version** *(string) --* 

            The S3 bucket version.

            
      
    
      

      - **sbomValidationStatus** *(string) --* 

        The status of the initial validation for the software bill of materials against the Software Package Data Exchange (SPDX) and CycloneDX industry standard formats.

        
  
  **Exceptions**
  
  *   :py:class:`IoT.Client.exceptions.ThrottlingException`

  
  *   :py:class:`IoT.Client.exceptions.ConflictException`

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

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

  
  *   :py:class:`IoT.Client.exceptions.ServiceQuotaExceededException`

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

  