DeleteProjectVersion.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.Rekognition.DeleteProjectVersion
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Deletes an Amazon Rekognition Custom Labels model.
--
-- You can\'t delete a model if it is running or if it is training. To
-- check the status of a model, use the @Status@ field returned from
-- DescribeProjectVersions. To stop a running model call
-- StopProjectVersion. If the model is training, wait until it finishes.
--
-- This operation requires permissions to perform the
-- @rekognition:DeleteProjectVersion@ action.
module Amazonka.Rekognition.DeleteProjectVersion
  ( -- * Creating a Request
    DeleteProjectVersion (..),
    newDeleteProjectVersion,

    -- * Request Lenses
    deleteProjectVersion_projectVersionArn,

    -- * Destructuring the Response
    DeleteProjectVersionResponse (..),
    newDeleteProjectVersionResponse,

    -- * Response Lenses
    deleteProjectVersionResponse_status,
    deleteProjectVersionResponse_httpStatus,
  )
where

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 Amazonka.Rekognition.Types
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newDeleteProjectVersion' smart constructor.
data DeleteProjectVersion = DeleteProjectVersion'
  { -- | The Amazon Resource Name (ARN) of the model version that you want to
    -- delete.
    projectVersionArn :: Prelude.Text
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'DeleteProjectVersion' 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:
--
-- 'projectVersionArn', 'deleteProjectVersion_projectVersionArn' - The Amazon Resource Name (ARN) of the model version that you want to
-- delete.
newDeleteProjectVersion ::
  -- | 'projectVersionArn'
  Prelude.Text ->
  DeleteProjectVersion
newDeleteProjectVersion pProjectVersionArn_ =
  DeleteProjectVersion'
    { projectVersionArn =
        pProjectVersionArn_
    }

-- | The Amazon Resource Name (ARN) of the model version that you want to
-- delete.
deleteProjectVersion_projectVersionArn :: Lens.Lens' DeleteProjectVersion Prelude.Text
deleteProjectVersion_projectVersionArn = Lens.lens (\DeleteProjectVersion' {projectVersionArn} -> projectVersionArn) (\s@DeleteProjectVersion' {} a -> s {projectVersionArn = a} :: DeleteProjectVersion)

instance Core.AWSRequest DeleteProjectVersion where
  type
    AWSResponse DeleteProjectVersion =
      DeleteProjectVersionResponse
  request overrides =
    Request.postJSON (overrides defaultService)
  response =
    Response.receiveJSON
      ( \s h x ->
          DeleteProjectVersionResponse'
            Prelude.<$> (x Data..?> "Status")
            Prelude.<*> (Prelude.pure (Prelude.fromEnum s))
      )

instance Prelude.Hashable DeleteProjectVersion where
  hashWithSalt _salt DeleteProjectVersion' {..} =
    _salt `Prelude.hashWithSalt` projectVersionArn

instance Prelude.NFData DeleteProjectVersion where
  rnf DeleteProjectVersion' {..} =
    Prelude.rnf projectVersionArn

instance Data.ToHeaders DeleteProjectVersion where
  toHeaders =
    Prelude.const
      ( Prelude.mconcat
          [ "X-Amz-Target"
              Data.=# ( "RekognitionService.DeleteProjectVersion" ::
                          Prelude.ByteString
                      ),
            "Content-Type"
              Data.=# ( "application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON DeleteProjectVersion where
  toJSON DeleteProjectVersion' {..} =
    Data.object
      ( Prelude.catMaybes
          [ Prelude.Just
              ("ProjectVersionArn" Data..= projectVersionArn)
          ]
      )

instance Data.ToPath DeleteProjectVersion where
  toPath = Prelude.const "/"

instance Data.ToQuery DeleteProjectVersion where
  toQuery = Prelude.const Prelude.mempty

-- | /See:/ 'newDeleteProjectVersionResponse' smart constructor.
data DeleteProjectVersionResponse = DeleteProjectVersionResponse'
  { -- | The status of the deletion operation.
    status :: Prelude.Maybe ProjectVersionStatus,
    -- | The response's http status code.
    httpStatus :: Prelude.Int
  }
  deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)

-- |
-- Create a value of 'DeleteProjectVersionResponse' 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:
--
-- 'status', 'deleteProjectVersionResponse_status' - The status of the deletion operation.
--
-- 'httpStatus', 'deleteProjectVersionResponse_httpStatus' - The response's http status code.
newDeleteProjectVersionResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DeleteProjectVersionResponse
newDeleteProjectVersionResponse pHttpStatus_ =
  DeleteProjectVersionResponse'
    { status =
        Prelude.Nothing,
      httpStatus = pHttpStatus_
    }

-- | The status of the deletion operation.
deleteProjectVersionResponse_status :: Lens.Lens' DeleteProjectVersionResponse (Prelude.Maybe ProjectVersionStatus)
deleteProjectVersionResponse_status = Lens.lens (\DeleteProjectVersionResponse' {status} -> status) (\s@DeleteProjectVersionResponse' {} a -> s {status = a} :: DeleteProjectVersionResponse)

-- | The response's http status code.
deleteProjectVersionResponse_httpStatus :: Lens.Lens' DeleteProjectVersionResponse Prelude.Int
deleteProjectVersionResponse_httpStatus = Lens.lens (\DeleteProjectVersionResponse' {httpStatus} -> httpStatus) (\s@DeleteProjectVersionResponse' {} a -> s {httpStatus = a} :: DeleteProjectVersionResponse)

instance Prelude.NFData DeleteProjectVersionResponse where
  rnf DeleteProjectVersionResponse' {..} =
    Prelude.rnf status
      `Prelude.seq` Prelude.rnf httpStatus