:doc:`AppStream <../../appstream>` / Client / copy_image

**********
copy_image
**********



.. py:method:: AppStream.Client.copy_image(**kwargs)

  

  Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/appstream-2016-12-01/CopyImage>`_  


  **Request Syntax**
  ::

    response = client.copy_image(
        SourceImageName='string',
        DestinationImageName='string',
        DestinationRegion='string',
        DestinationImageDescription='string'
    )
    
  :type SourceImageName: string
  :param SourceImageName: **[REQUIRED]** 

    The name of the image to copy.

    

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

    The name that the image will have when it is copied to the destination.

    

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

    The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.

    

  
  :type DestinationImageDescription: string
  :param DestinationImageDescription: 

    The description that the image will have when it is copied to the destination.

    

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

    
    ::

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

    

    - *(dict) --* 
      

      - **DestinationImageName** *(string) --* 

        The name of the destination image.

        
  
  **Exceptions**
  
  *   :py:class:`AppStream.Client.exceptions.ResourceAlreadyExistsException`

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

  
  *   :py:class:`AppStream.Client.exceptions.ResourceNotAvailableException`

  
  *   :py:class:`AppStream.Client.exceptions.LimitExceededException`

  
  *   :py:class:`AppStream.Client.exceptions.InvalidAccountStatusException`

  
  *   :py:class:`AppStream.Client.exceptions.IncompatibleImageException`

  