:doc:`EC2 <../../ec2>` / Client / copy_fpga_image

***************
copy_fpga_image
***************



.. py:method:: EC2.Client.copy_fpga_image(**kwargs)

  

  Copies the specified Amazon FPGA Image (AFI) to the current Region.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/CopyFpgaImage>`_  


  **Request Syntax**
  ::

    response = client.copy_fpga_image(
        DryRun=True|False,
        SourceFpgaImageId='string',
        Description='string',
        Name='string',
        SourceRegion='string',
        ClientToken='string'
    )
    
  :type DryRun: boolean
  :param DryRun: 

    Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is ``DryRunOperation``. Otherwise, it is ``UnauthorizedOperation``.

    

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

    The ID of the source AFI.

    

  
  :type Description: string
  :param Description: 

    The description for the new AFI.

    

  
  :type Name: string
  :param Name: 

    The name for the new AFI. The default is the name of the source AFI.

    

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

    The Region that contains the source AFI.

    

  
  :type ClientToken: string
  :param ClientToken: 

    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see `Ensuring idempotency <https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html>`__.

    

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

    
    ::

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

    

    - *(dict) --* 
      

      - **FpgaImageId** *(string) --* 

        The ID of the new AFI.

        
  