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

****************
import_component
****************



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

  

  Imports a component and transforms its data into a component document.

  

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


  **Request Syntax**
  ::

    response = client.import_component(
        name='string',
        semanticVersion='string',
        description='string',
        changeDescription='string',
        type='BUILD'|'TEST',
        format='SHELL',
        platform='Windows'|'Linux'|'macOS',
        data='string',
        uri='string',
        kmsKeyId='string',
        tags={
            'string': 'string'
        },
        clientToken='string'
    )
    
  :type name: string
  :param name: **[REQUIRED]** 

    The name of the component.

    

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

    The semantic version of the component. This version follows the semantic version syntax.

     

    .. note::

      

      The semantic version has four nodes: <major>.<minor>.<patch>/<build>. You can assign values for the first three, and can filter on all of them.

       

      **Filtering:** With semantic versioning, you have the flexibility to use wildcards (x) to specify the most recent versions or nodes when selecting the base image or components for your recipe. When you use a wildcard in any node, all nodes to the right of the first wildcard must also be wildcards.

      

    

  
  :type description: string
  :param description: 

    The description of the component. Describes the contents of the component.

    

  
  :type changeDescription: string
  :param changeDescription: 

    The change description of the component. This description indicates the change that has been made in this version, or what makes this version different from other versions of the component.

    

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

    The type of the component denotes whether the component is used to build the image, or only to test it.

    

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

    The format of the resource that you want to import as a component.

    

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

    The platform of the component.

    

  
  :type data: string
  :param data: 

    The data of the component. Used to specify the data inline. Either ``data`` or ``uri`` can be used to specify the data within the component.

    

  
  :type uri: string
  :param uri: 

    The uri of the component. Must be an Amazon S3 URL and the requester must have permission to access the Amazon S3 bucket. If you use Amazon S3, you can specify component content up to your service quota. Either ``data`` or ``uri`` can be used to specify the data within the component.

    

  
  :type kmsKeyId: string
  :param kmsKeyId: 

    The Amazon Resource Name (ARN) that uniquely identifies the KMS key used to encrypt this component. This can be either the Key ARN or the Alias ARN. For more information, see `Key identifiers (KeyId) <https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id-key-ARN>`__ in the *Key Management Service Developer Guide*.

    

  
  :type tags: dict
  :param tags: 

    The tags of the component.

    

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

    
    ::

      {
          'requestId': 'string',
          'clientToken': 'string',
          'componentBuildVersionArn': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **requestId** *(string) --* 

        The request ID that uniquely identifies this request.

        
      

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

        The client token that uniquely identifies the request.

        
      

      - **componentBuildVersionArn** *(string) --* 

        The Amazon Resource Name (ARN) of the imported component.

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

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

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

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

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

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

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

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

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

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

  