amazonka-appstream-2.0: gen/Amazonka/AppStream/CopyImage.hs
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}
-- Derived from AWS service descriptions, licensed under Apache 2.0.
-- |
-- Module : Amazonka.AppStream.CopyImage
-- Copyright : (c) 2013-2023 Brendan Hay
-- License : Mozilla Public License, v. 2.0.
-- Maintainer : Brendan Hay
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- 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.
module Amazonka.AppStream.CopyImage
( -- * Creating a Request
CopyImage (..),
newCopyImage,
-- * Request Lenses
copyImage_destinationImageDescription,
copyImage_sourceImageName,
copyImage_destinationImageName,
copyImage_destinationRegion,
-- * Destructuring the Response
CopyImageResponse (..),
newCopyImageResponse,
-- * Response Lenses
copyImageResponse_destinationImageName,
copyImageResponse_httpStatus,
)
where
import Amazonka.AppStream.Types
import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response
-- | /See:/ 'newCopyImage' smart constructor.
data CopyImage = CopyImage'
{ -- | The description that the image will have when it is copied to the
-- destination.
destinationImageDescription :: Prelude.Maybe Prelude.Text,
-- | The name of the image to copy.
sourceImageName :: Prelude.Text,
-- | The name that the image will have when it is copied to the destination.
destinationImageName :: Prelude.Text,
-- | 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.
destinationRegion :: Prelude.Text
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'CopyImage' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'destinationImageDescription', 'copyImage_destinationImageDescription' - The description that the image will have when it is copied to the
-- destination.
--
-- 'sourceImageName', 'copyImage_sourceImageName' - The name of the image to copy.
--
-- 'destinationImageName', 'copyImage_destinationImageName' - The name that the image will have when it is copied to the destination.
--
-- 'destinationRegion', 'copyImage_destinationRegion' - 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.
newCopyImage ::
-- | 'sourceImageName'
Prelude.Text ->
-- | 'destinationImageName'
Prelude.Text ->
-- | 'destinationRegion'
Prelude.Text ->
CopyImage
newCopyImage
pSourceImageName_
pDestinationImageName_
pDestinationRegion_ =
CopyImage'
{ destinationImageDescription =
Prelude.Nothing,
sourceImageName = pSourceImageName_,
destinationImageName = pDestinationImageName_,
destinationRegion = pDestinationRegion_
}
-- | The description that the image will have when it is copied to the
-- destination.
copyImage_destinationImageDescription :: Lens.Lens' CopyImage (Prelude.Maybe Prelude.Text)
copyImage_destinationImageDescription = Lens.lens (\CopyImage' {destinationImageDescription} -> destinationImageDescription) (\s@CopyImage' {} a -> s {destinationImageDescription = a} :: CopyImage)
-- | The name of the image to copy.
copyImage_sourceImageName :: Lens.Lens' CopyImage Prelude.Text
copyImage_sourceImageName = Lens.lens (\CopyImage' {sourceImageName} -> sourceImageName) (\s@CopyImage' {} a -> s {sourceImageName = a} :: CopyImage)
-- | The name that the image will have when it is copied to the destination.
copyImage_destinationImageName :: Lens.Lens' CopyImage Prelude.Text
copyImage_destinationImageName = Lens.lens (\CopyImage' {destinationImageName} -> destinationImageName) (\s@CopyImage' {} a -> s {destinationImageName = a} :: CopyImage)
-- | 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.
copyImage_destinationRegion :: Lens.Lens' CopyImage Prelude.Text
copyImage_destinationRegion = Lens.lens (\CopyImage' {destinationRegion} -> destinationRegion) (\s@CopyImage' {} a -> s {destinationRegion = a} :: CopyImage)
instance Core.AWSRequest CopyImage where
type AWSResponse CopyImage = CopyImageResponse
request overrides =
Request.postJSON (overrides defaultService)
response =
Response.receiveJSON
( \s h x ->
CopyImageResponse'
Prelude.<$> (x Data..?> "DestinationImageName")
Prelude.<*> (Prelude.pure (Prelude.fromEnum s))
)
instance Prelude.Hashable CopyImage where
hashWithSalt _salt CopyImage' {..} =
_salt
`Prelude.hashWithSalt` destinationImageDescription
`Prelude.hashWithSalt` sourceImageName
`Prelude.hashWithSalt` destinationImageName
`Prelude.hashWithSalt` destinationRegion
instance Prelude.NFData CopyImage where
rnf CopyImage' {..} =
Prelude.rnf destinationImageDescription
`Prelude.seq` Prelude.rnf sourceImageName
`Prelude.seq` Prelude.rnf destinationImageName
`Prelude.seq` Prelude.rnf destinationRegion
instance Data.ToHeaders CopyImage where
toHeaders =
Prelude.const
( Prelude.mconcat
[ "X-Amz-Target"
Data.=# ( "PhotonAdminProxyService.CopyImage" ::
Prelude.ByteString
),
"Content-Type"
Data.=# ( "application/x-amz-json-1.1" ::
Prelude.ByteString
)
]
)
instance Data.ToJSON CopyImage where
toJSON CopyImage' {..} =
Data.object
( Prelude.catMaybes
[ ("DestinationImageDescription" Data..=)
Prelude.<$> destinationImageDescription,
Prelude.Just
("SourceImageName" Data..= sourceImageName),
Prelude.Just
( "DestinationImageName"
Data..= destinationImageName
),
Prelude.Just
("DestinationRegion" Data..= destinationRegion)
]
)
instance Data.ToPath CopyImage where
toPath = Prelude.const "/"
instance Data.ToQuery CopyImage where
toQuery = Prelude.const Prelude.mempty
-- | /See:/ 'newCopyImageResponse' smart constructor.
data CopyImageResponse = CopyImageResponse'
{ -- | The name of the destination image.
destinationImageName :: Prelude.Maybe Prelude.Text,
-- | The response's http status code.
httpStatus :: Prelude.Int
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'CopyImageResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'destinationImageName', 'copyImageResponse_destinationImageName' - The name of the destination image.
--
-- 'httpStatus', 'copyImageResponse_httpStatus' - The response's http status code.
newCopyImageResponse ::
-- | 'httpStatus'
Prelude.Int ->
CopyImageResponse
newCopyImageResponse pHttpStatus_ =
CopyImageResponse'
{ destinationImageName =
Prelude.Nothing,
httpStatus = pHttpStatus_
}
-- | The name of the destination image.
copyImageResponse_destinationImageName :: Lens.Lens' CopyImageResponse (Prelude.Maybe Prelude.Text)
copyImageResponse_destinationImageName = Lens.lens (\CopyImageResponse' {destinationImageName} -> destinationImageName) (\s@CopyImageResponse' {} a -> s {destinationImageName = a} :: CopyImageResponse)
-- | The response's http status code.
copyImageResponse_httpStatus :: Lens.Lens' CopyImageResponse Prelude.Int
copyImageResponse_httpStatus = Lens.lens (\CopyImageResponse' {httpStatus} -> httpStatus) (\s@CopyImageResponse' {} a -> s {httpStatus = a} :: CopyImageResponse)
instance Prelude.NFData CopyImageResponse where
rnf CopyImageResponse' {..} =
Prelude.rnf destinationImageName
`Prelude.seq` Prelude.rnf httpStatus