{-# 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.IoTEvents.DescribeDetectorModelAnalysis -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Retrieves runtime information about a detector model analysis. -- -- After AWS IoT Events starts analyzing your detector model, you have up -- to 24 hours to retrieve the analysis results. module Amazonka.IoTEvents.DescribeDetectorModelAnalysis ( -- * Creating a Request DescribeDetectorModelAnalysis (..), newDescribeDetectorModelAnalysis, -- * Request Lenses describeDetectorModelAnalysis_analysisId, -- * Destructuring the Response DescribeDetectorModelAnalysisResponse (..), newDescribeDetectorModelAnalysisResponse, -- * Response Lenses describeDetectorModelAnalysisResponse_status, describeDetectorModelAnalysisResponse_httpStatus, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.IoTEvents.Types import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newDescribeDetectorModelAnalysis' smart constructor. data DescribeDetectorModelAnalysis = DescribeDetectorModelAnalysis' { -- | The ID of the analysis result that you want to retrieve. analysisId :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeDetectorModelAnalysis' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'analysisId', 'describeDetectorModelAnalysis_analysisId' - The ID of the analysis result that you want to retrieve. newDescribeDetectorModelAnalysis :: -- | 'analysisId' Prelude.Text -> DescribeDetectorModelAnalysis newDescribeDetectorModelAnalysis pAnalysisId_ = DescribeDetectorModelAnalysis' { analysisId = pAnalysisId_ } -- | The ID of the analysis result that you want to retrieve. describeDetectorModelAnalysis_analysisId :: Lens.Lens' DescribeDetectorModelAnalysis Prelude.Text describeDetectorModelAnalysis_analysisId = Lens.lens (\DescribeDetectorModelAnalysis' {analysisId} -> analysisId) (\s@DescribeDetectorModelAnalysis' {} a -> s {analysisId = a} :: DescribeDetectorModelAnalysis) instance Core.AWSRequest DescribeDetectorModelAnalysis where type AWSResponse DescribeDetectorModelAnalysis = DescribeDetectorModelAnalysisResponse request overrides = Request.get (overrides defaultService) response = Response.receiveJSON ( \s h x -> DescribeDetectorModelAnalysisResponse' Prelude.<$> (x Data..?> "status") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable DescribeDetectorModelAnalysis where hashWithSalt _salt DescribeDetectorModelAnalysis' {..} = _salt `Prelude.hashWithSalt` analysisId instance Prelude.NFData DescribeDetectorModelAnalysis where rnf DescribeDetectorModelAnalysis' {..} = Prelude.rnf analysisId instance Data.ToHeaders DescribeDetectorModelAnalysis where toHeaders = Prelude.const Prelude.mempty instance Data.ToPath DescribeDetectorModelAnalysis where toPath DescribeDetectorModelAnalysis' {..} = Prelude.mconcat ["/analysis/detector-models/", Data.toBS analysisId] instance Data.ToQuery DescribeDetectorModelAnalysis where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newDescribeDetectorModelAnalysisResponse' smart constructor. data DescribeDetectorModelAnalysisResponse = DescribeDetectorModelAnalysisResponse' { -- | The status of the analysis activity. The status can be one of the -- following values: -- -- - @RUNNING@ - AWS IoT Events is analyzing your detector model. This -- process can take several minutes to complete. -- -- - @COMPLETE@ - AWS IoT Events finished analyzing your detector model. -- -- - @FAILED@ - AWS IoT Events couldn\'t analyze your detector model. Try -- again later. status :: Prelude.Maybe AnalysisStatus, -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeDetectorModelAnalysisResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'status', 'describeDetectorModelAnalysisResponse_status' - The status of the analysis activity. The status can be one of the -- following values: -- -- - @RUNNING@ - AWS IoT Events is analyzing your detector model. This -- process can take several minutes to complete. -- -- - @COMPLETE@ - AWS IoT Events finished analyzing your detector model. -- -- - @FAILED@ - AWS IoT Events couldn\'t analyze your detector model. Try -- again later. -- -- 'httpStatus', 'describeDetectorModelAnalysisResponse_httpStatus' - The response's http status code. newDescribeDetectorModelAnalysisResponse :: -- | 'httpStatus' Prelude.Int -> DescribeDetectorModelAnalysisResponse newDescribeDetectorModelAnalysisResponse pHttpStatus_ = DescribeDetectorModelAnalysisResponse' { status = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | The status of the analysis activity. The status can be one of the -- following values: -- -- - @RUNNING@ - AWS IoT Events is analyzing your detector model. This -- process can take several minutes to complete. -- -- - @COMPLETE@ - AWS IoT Events finished analyzing your detector model. -- -- - @FAILED@ - AWS IoT Events couldn\'t analyze your detector model. Try -- again later. describeDetectorModelAnalysisResponse_status :: Lens.Lens' DescribeDetectorModelAnalysisResponse (Prelude.Maybe AnalysisStatus) describeDetectorModelAnalysisResponse_status = Lens.lens (\DescribeDetectorModelAnalysisResponse' {status} -> status) (\s@DescribeDetectorModelAnalysisResponse' {} a -> s {status = a} :: DescribeDetectorModelAnalysisResponse) -- | The response's http status code. describeDetectorModelAnalysisResponse_httpStatus :: Lens.Lens' DescribeDetectorModelAnalysisResponse Prelude.Int describeDetectorModelAnalysisResponse_httpStatus = Lens.lens (\DescribeDetectorModelAnalysisResponse' {httpStatus} -> httpStatus) (\s@DescribeDetectorModelAnalysisResponse' {} a -> s {httpStatus = a} :: DescribeDetectorModelAnalysisResponse) instance Prelude.NFData DescribeDetectorModelAnalysisResponse where rnf DescribeDetectorModelAnalysisResponse' {..} = Prelude.rnf status `Prelude.seq` Prelude.rnf httpStatus