{-# 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.IoTAnalytics.RunPipelineActivity -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Simulates the results of running a pipeline activity on a message -- payload. module Amazonka.IoTAnalytics.RunPipelineActivity ( -- * Creating a Request RunPipelineActivity (..), newRunPipelineActivity, -- * Request Lenses runPipelineActivity_pipelineActivity, runPipelineActivity_payloads, -- * Destructuring the Response RunPipelineActivityResponse (..), newRunPipelineActivityResponse, -- * Response Lenses runPipelineActivityResponse_logResult, runPipelineActivityResponse_payloads, runPipelineActivityResponse_httpStatus, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.IoTAnalytics.Types import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | /See:/ 'newRunPipelineActivity' smart constructor. data RunPipelineActivity = RunPipelineActivity' { -- | The pipeline activity that is run. This must not be a channel activity -- or a data store activity because these activities are used in a pipeline -- only to load the original message and to store the (possibly) -- transformed message. If a Lambda activity is specified, only -- short-running Lambda functions (those with a timeout of less than 30 -- seconds or less) can be used. pipelineActivity :: PipelineActivity, -- | The sample message payloads on which the pipeline activity is run. payloads :: Prelude.NonEmpty Data.Base64 } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'RunPipelineActivity' 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: -- -- 'pipelineActivity', 'runPipelineActivity_pipelineActivity' - The pipeline activity that is run. This must not be a channel activity -- or a data store activity because these activities are used in a pipeline -- only to load the original message and to store the (possibly) -- transformed message. If a Lambda activity is specified, only -- short-running Lambda functions (those with a timeout of less than 30 -- seconds or less) can be used. -- -- 'payloads', 'runPipelineActivity_payloads' - The sample message payloads on which the pipeline activity is run. newRunPipelineActivity :: -- | 'pipelineActivity' PipelineActivity -> -- | 'payloads' Prelude.NonEmpty Prelude.ByteString -> RunPipelineActivity newRunPipelineActivity pPipelineActivity_ pPayloads_ = RunPipelineActivity' { pipelineActivity = pPipelineActivity_, payloads = Lens.coerced Lens.# pPayloads_ } -- | The pipeline activity that is run. This must not be a channel activity -- or a data store activity because these activities are used in a pipeline -- only to load the original message and to store the (possibly) -- transformed message. If a Lambda activity is specified, only -- short-running Lambda functions (those with a timeout of less than 30 -- seconds or less) can be used. runPipelineActivity_pipelineActivity :: Lens.Lens' RunPipelineActivity PipelineActivity runPipelineActivity_pipelineActivity = Lens.lens (\RunPipelineActivity' {pipelineActivity} -> pipelineActivity) (\s@RunPipelineActivity' {} a -> s {pipelineActivity = a} :: RunPipelineActivity) -- | The sample message payloads on which the pipeline activity is run. runPipelineActivity_payloads :: Lens.Lens' RunPipelineActivity (Prelude.NonEmpty Prelude.ByteString) runPipelineActivity_payloads = Lens.lens (\RunPipelineActivity' {payloads} -> payloads) (\s@RunPipelineActivity' {} a -> s {payloads = a} :: RunPipelineActivity) Prelude.. Lens.coerced instance Core.AWSRequest RunPipelineActivity where type AWSResponse RunPipelineActivity = RunPipelineActivityResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> RunPipelineActivityResponse' Prelude.<$> (x Data..?> "logResult") Prelude.<*> (x Data..?> "payloads") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable RunPipelineActivity where hashWithSalt _salt RunPipelineActivity' {..} = _salt `Prelude.hashWithSalt` pipelineActivity `Prelude.hashWithSalt` payloads instance Prelude.NFData RunPipelineActivity where rnf RunPipelineActivity' {..} = Prelude.rnf pipelineActivity `Prelude.seq` Prelude.rnf payloads instance Data.ToHeaders RunPipelineActivity where toHeaders = Prelude.const Prelude.mempty instance Data.ToJSON RunPipelineActivity where toJSON RunPipelineActivity' {..} = Data.object ( Prelude.catMaybes [ Prelude.Just ("pipelineActivity" Data..= pipelineActivity), Prelude.Just ("payloads" Data..= payloads) ] ) instance Data.ToPath RunPipelineActivity where toPath = Prelude.const "/pipelineactivities/run" instance Data.ToQuery RunPipelineActivity where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newRunPipelineActivityResponse' smart constructor. data RunPipelineActivityResponse = RunPipelineActivityResponse' { -- | In case the pipeline activity fails, the log message that is generated. logResult :: Prelude.Maybe Prelude.Text, -- | The enriched or transformed sample message payloads as base64-encoded -- strings. (The results of running the pipeline activity on each input -- sample message payload, encoded in base64.) payloads :: Prelude.Maybe (Prelude.NonEmpty Data.Base64), -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'RunPipelineActivityResponse' 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: -- -- 'logResult', 'runPipelineActivityResponse_logResult' - In case the pipeline activity fails, the log message that is generated. -- -- 'payloads', 'runPipelineActivityResponse_payloads' - The enriched or transformed sample message payloads as base64-encoded -- strings. (The results of running the pipeline activity on each input -- sample message payload, encoded in base64.) -- -- 'httpStatus', 'runPipelineActivityResponse_httpStatus' - The response's http status code. newRunPipelineActivityResponse :: -- | 'httpStatus' Prelude.Int -> RunPipelineActivityResponse newRunPipelineActivityResponse pHttpStatus_ = RunPipelineActivityResponse' { logResult = Prelude.Nothing, payloads = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | In case the pipeline activity fails, the log message that is generated. runPipelineActivityResponse_logResult :: Lens.Lens' RunPipelineActivityResponse (Prelude.Maybe Prelude.Text) runPipelineActivityResponse_logResult = Lens.lens (\RunPipelineActivityResponse' {logResult} -> logResult) (\s@RunPipelineActivityResponse' {} a -> s {logResult = a} :: RunPipelineActivityResponse) -- | The enriched or transformed sample message payloads as base64-encoded -- strings. (The results of running the pipeline activity on each input -- sample message payload, encoded in base64.) runPipelineActivityResponse_payloads :: Lens.Lens' RunPipelineActivityResponse (Prelude.Maybe (Prelude.NonEmpty Prelude.ByteString)) runPipelineActivityResponse_payloads = Lens.lens (\RunPipelineActivityResponse' {payloads} -> payloads) (\s@RunPipelineActivityResponse' {} a -> s {payloads = a} :: RunPipelineActivityResponse) Prelude.. Lens.mapping Lens.coerced -- | The response's http status code. runPipelineActivityResponse_httpStatus :: Lens.Lens' RunPipelineActivityResponse Prelude.Int runPipelineActivityResponse_httpStatus = Lens.lens (\RunPipelineActivityResponse' {httpStatus} -> httpStatus) (\s@RunPipelineActivityResponse' {} a -> s {httpStatus = a} :: RunPipelineActivityResponse) instance Prelude.NFData RunPipelineActivityResponse where rnf RunPipelineActivityResponse' {..} = Prelude.rnf logResult `Prelude.seq` Prelude.rnf payloads `Prelude.seq` Prelude.rnf httpStatus