amazonka-comprehend-2.0: gen/Amazonka/Comprehend/DeleteEntityRecognizer.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.Comprehend.DeleteEntityRecognizer
-- 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 entity recognizer.
--
-- Only those recognizers that are in terminated states (IN_ERROR, TRAINED)
-- will be deleted. If an active inference job is using the model, a
-- @ResourceInUseException@ will be returned.
--
-- This is an asynchronous action that puts the recognizer into a DELETING
-- state, and it is then removed by a background job. Once removed, the
-- recognizer disappears from your account and is no longer available for
-- use.
module Amazonka.Comprehend.DeleteEntityRecognizer
( -- * Creating a Request
DeleteEntityRecognizer (..),
newDeleteEntityRecognizer,
-- * Request Lenses
deleteEntityRecognizer_entityRecognizerArn,
-- * Destructuring the Response
DeleteEntityRecognizerResponse (..),
newDeleteEntityRecognizerResponse,
-- * Response Lenses
deleteEntityRecognizerResponse_httpStatus,
)
where
import Amazonka.Comprehend.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:/ 'newDeleteEntityRecognizer' smart constructor.
data DeleteEntityRecognizer = DeleteEntityRecognizer'
{ -- | The Amazon Resource Name (ARN) that identifies the entity recognizer.
entityRecognizerArn :: Prelude.Text
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'DeleteEntityRecognizer' 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:
--
-- 'entityRecognizerArn', 'deleteEntityRecognizer_entityRecognizerArn' - The Amazon Resource Name (ARN) that identifies the entity recognizer.
newDeleteEntityRecognizer ::
-- | 'entityRecognizerArn'
Prelude.Text ->
DeleteEntityRecognizer
newDeleteEntityRecognizer pEntityRecognizerArn_ =
DeleteEntityRecognizer'
{ entityRecognizerArn =
pEntityRecognizerArn_
}
-- | The Amazon Resource Name (ARN) that identifies the entity recognizer.
deleteEntityRecognizer_entityRecognizerArn :: Lens.Lens' DeleteEntityRecognizer Prelude.Text
deleteEntityRecognizer_entityRecognizerArn = Lens.lens (\DeleteEntityRecognizer' {entityRecognizerArn} -> entityRecognizerArn) (\s@DeleteEntityRecognizer' {} a -> s {entityRecognizerArn = a} :: DeleteEntityRecognizer)
instance Core.AWSRequest DeleteEntityRecognizer where
type
AWSResponse DeleteEntityRecognizer =
DeleteEntityRecognizerResponse
request overrides =
Request.postJSON (overrides defaultService)
response =
Response.receiveEmpty
( \s h x ->
DeleteEntityRecognizerResponse'
Prelude.<$> (Prelude.pure (Prelude.fromEnum s))
)
instance Prelude.Hashable DeleteEntityRecognizer where
hashWithSalt _salt DeleteEntityRecognizer' {..} =
_salt `Prelude.hashWithSalt` entityRecognizerArn
instance Prelude.NFData DeleteEntityRecognizer where
rnf DeleteEntityRecognizer' {..} =
Prelude.rnf entityRecognizerArn
instance Data.ToHeaders DeleteEntityRecognizer where
toHeaders =
Prelude.const
( Prelude.mconcat
[ "X-Amz-Target"
Data.=# ( "Comprehend_20171127.DeleteEntityRecognizer" ::
Prelude.ByteString
),
"Content-Type"
Data.=# ( "application/x-amz-json-1.1" ::
Prelude.ByteString
)
]
)
instance Data.ToJSON DeleteEntityRecognizer where
toJSON DeleteEntityRecognizer' {..} =
Data.object
( Prelude.catMaybes
[ Prelude.Just
("EntityRecognizerArn" Data..= entityRecognizerArn)
]
)
instance Data.ToPath DeleteEntityRecognizer where
toPath = Prelude.const "/"
instance Data.ToQuery DeleteEntityRecognizer where
toQuery = Prelude.const Prelude.mempty
-- | /See:/ 'newDeleteEntityRecognizerResponse' smart constructor.
data DeleteEntityRecognizerResponse = DeleteEntityRecognizerResponse'
{ -- | The response's http status code.
httpStatus :: Prelude.Int
}
deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic)
-- |
-- Create a value of 'DeleteEntityRecognizerResponse' 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:
--
-- 'httpStatus', 'deleteEntityRecognizerResponse_httpStatus' - The response's http status code.
newDeleteEntityRecognizerResponse ::
-- | 'httpStatus'
Prelude.Int ->
DeleteEntityRecognizerResponse
newDeleteEntityRecognizerResponse pHttpStatus_ =
DeleteEntityRecognizerResponse'
{ httpStatus =
pHttpStatus_
}
-- | The response's http status code.
deleteEntityRecognizerResponse_httpStatus :: Lens.Lens' DeleteEntityRecognizerResponse Prelude.Int
deleteEntityRecognizerResponse_httpStatus = Lens.lens (\DeleteEntityRecognizerResponse' {httpStatus} -> httpStatus) (\s@DeleteEntityRecognizerResponse' {} a -> s {httpStatus = a} :: DeleteEntityRecognizerResponse)
instance
Prelude.NFData
DeleteEntityRecognizerResponse
where
rnf DeleteEntityRecognizerResponse' {..} =
Prelude.rnf httpStatus