AppStream / Client / copy_image

copy_image#

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

Request Syntax

response = client.copy_image(
    SourceImageName='string',
    DestinationImageName='string',
    DestinationRegion='string',
    DestinationImageDescription='string'
)
Parameters:
  • SourceImageName (string) –

    [REQUIRED]

    The name of the image to copy.

  • DestinationImageName (string) –

    [REQUIRED]

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

  • DestinationRegion (string) –

    [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.

  • DestinationImageDescription (string) – The description that the image will have when it is copied to the destination.

Return type:

dict

Returns:

Response Syntax

{
    'DestinationImageName': 'string'
}

Response Structure

  • (dict) –

    • DestinationImageName (string) –

      The name of the destination image.

Exceptions

  • AppStream.Client.exceptions.ResourceAlreadyExistsException

  • AppStream.Client.exceptions.ResourceNotFoundException

  • AppStream.Client.exceptions.ResourceNotAvailableException

  • AppStream.Client.exceptions.LimitExceededException

  • AppStream.Client.exceptions.InvalidAccountStatusException

  • AppStream.Client.exceptions.IncompatibleImageException