:doc:`imagebuilder <../../imagebuilder>` / Client / import_disk_image

*****************
import_disk_image
*****************



.. py:method:: imagebuilder.Client.import_disk_image(**kwargs)

  

  Import a Windows operating system image from a verified Microsoft ISO disk file. The following disk images are supported:

   

  
  * Windows 11 Enterprise
  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/imagebuilder-2019-12-02/ImportDiskImage>`_  


  **Request Syntax**
  ::

    response = client.import_disk_image(
        name='string',
        semanticVersion='string',
        description='string',
        platform='string',
        osVersion='string',
        executionRole='string',
        infrastructureConfigurationArn='string',
        uri='string',
        loggingConfiguration={
            'logGroupName': 'string'
        },
        tags={
            'string': 'string'
        },
        clientToken='string'
    )
    
  :type name: string
  :param name: **[REQUIRED]** 

    The name of the image resource that's created from the import.

    

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

    The semantic version to attach to the image that's created during the import process. This version follows the semantic version syntax.

    

  
  :type description: string
  :param description: 

    The description for your disk image import.

    

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

    The operating system platform for the imported image. Allowed values include the following: ``Windows``.

    

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

    The operating system version for the imported image. Allowed values include the following: ``Microsoft Windows 11``.

    

  
  :type executionRole: string
  :param executionRole: 

    The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions to import an image from a Microsoft ISO file.

    

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

    The Amazon Resource Name (ARN) of the infrastructure configuration resource that's used for launching the EC2 instance on which the ISO image is built.

    

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

    The ``uri`` of the ISO disk file that's stored in Amazon S3.

    

  
  :type loggingConfiguration: dict
  :param loggingConfiguration: 

    Define logging configuration for the image build process.

    

  
    - **logGroupName** *(string) --* 

      The log group name that Image Builder uses for image creation. If not specified, the log group name defaults to ``/aws/imagebuilder/image-name``.

      

    
  
  :type tags: dict
  :param tags: 

    Tags that are attached to image resources created from the import.

    

  
    - *(string) --* 

    
      - *(string) --* 

      


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

    Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see `Ensuring idempotency <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html>`__ in the *Amazon EC2 API Reference*.

    This field is autopopulated if not provided.

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

    
    ::

      {
          'clientToken': 'string',
          'imageBuildVersionArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **clientToken** *(string) --* 

        The client token that uniquely identifies the request.

        
      

      - **imageBuildVersionArn** *(string) --* 

        The Amazon Resource Name (ARN) of the output AMI that was created from the ISO disk file.

        
  
  **Exceptions**
  
  *   :py:class:`imagebuilder.Client.exceptions.ServiceException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ClientException`

  
  *   :py:class:`imagebuilder.Client.exceptions.ServiceUnavailableException`

  