Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTAnalytics.RunPipelineActivity

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Simulates the results of running a pipeline activity on a message payload.

Synopsis

data RunPipelineActivity = RunPipelineActivity' {
- pipelineActivity :: PipelineActivity
- payloads :: NonEmpty Base64
}
newRunPipelineActivity :: PipelineActivity -> NonEmpty ByteString -> RunPipelineActivity
runPipelineActivity_pipelineActivity :: Lens' RunPipelineActivity PipelineActivity
runPipelineActivity_payloads :: Lens' RunPipelineActivity (NonEmpty ByteString)
data RunPipelineActivityResponse = RunPipelineActivityResponse' {
- logResult :: Maybe Text
- payloads :: Maybe (NonEmpty Base64)
- httpStatus :: Int
}
newRunPipelineActivityResponse :: Int -> RunPipelineActivityResponse
runPipelineActivityResponse_logResult :: Lens' RunPipelineActivityResponse (Maybe Text)
runPipelineActivityResponse_payloads :: Lens' RunPipelineActivityResponse (Maybe (NonEmpty ByteString))
runPipelineActivityResponse_httpStatus :: Lens' RunPipelineActivityResponse Int

Creating a Request

data RunPipelineActivity Source #

See: newRunPipelineActivity smart constructor.

Constructors

RunPipelineActivity'

Fields

pipelineActivity :: 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 :: NonEmpty Base64
The sample message payloads on which the pipeline activity is run.

Instances

Instances details

Eq RunPipelineActivity Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity Methods (==) :: RunPipelineActivity -> RunPipelineActivity -> Bool # (/=) :: RunPipelineActivity -> RunPipelineActivity -> Bool #
Read RunPipelineActivity Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity Methods readsPrec :: Int -> ReadS RunPipelineActivity # readList :: ReadS [RunPipelineActivity] # readPrec :: ReadPrec RunPipelineActivity # readListPrec :: ReadPrec [RunPipelineActivity] #
Show RunPipelineActivity Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity Methods showsPrec :: Int -> RunPipelineActivity -> ShowS # show :: RunPipelineActivity -> String # showList :: [RunPipelineActivity] -> ShowS #
Generic RunPipelineActivity Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity Associated Types type Rep RunPipelineActivity :: Type -> Type # Methods from :: RunPipelineActivity -> Rep RunPipelineActivity x # to :: Rep RunPipelineActivity x -> RunPipelineActivity #
NFData RunPipelineActivity Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity Methods rnf :: RunPipelineActivity -> () #
Hashable RunPipelineActivity Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity Methods hashWithSalt :: Int -> RunPipelineActivity -> Int # hash :: RunPipelineActivity -> Int #
ToJSON RunPipelineActivity Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity Methods toJSON :: RunPipelineActivity -> Value # toEncoding :: RunPipelineActivity -> Encoding # toJSONList :: [RunPipelineActivity] -> Value # toEncodingList :: [RunPipelineActivity] -> Encoding #
AWSRequest RunPipelineActivity Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity Associated Types type AWSResponse RunPipelineActivity # Methods request :: RunPipelineActivity -> Request RunPipelineActivity # response :: MonadResource m => Logger -> Service -> Proxy RunPipelineActivity -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RunPipelineActivity))) #
ToHeaders RunPipelineActivity Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity Methods toHeaders :: RunPipelineActivity -> [Header] #
ToPath RunPipelineActivity Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity Methods toPath :: RunPipelineActivity -> ByteString #
ToQuery RunPipelineActivity Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity Methods toQuery :: RunPipelineActivity -> QueryString #
type Rep RunPipelineActivity Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity type Rep RunPipelineActivity = D1 ('MetaData "RunPipelineActivity" "Amazonka.IoTAnalytics.RunPipelineActivity" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" 'False) (C1 ('MetaCons "RunPipelineActivity'" 'PrefixI 'True) (S1 ('MetaSel ('Just "pipelineActivity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 PipelineActivity) :*: S1 ('MetaSel ('Just "payloads") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Base64))))
type AWSResponse RunPipelineActivity Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity type AWSResponse RunPipelineActivity = RunPipelineActivityResponse

newRunPipelineActivity Source #

Arguments

:: PipelineActivity	`$sel:pipelineActivity:RunPipelineActivity'`
-> NonEmpty ByteString	`$sel:payloads:RunPipelineActivity'`
-> RunPipelineActivity

Create a value of RunPipelineActivity with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:pipelineActivity:RunPipelineActivity', 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.

$sel:payloads:RunPipelineActivity', runPipelineActivity_payloads - The sample message payloads on which the pipeline activity is run.

Request Lenses

runPipelineActivity_pipelineActivity :: Lens' RunPipelineActivity PipelineActivity Source #

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_payloads :: Lens' RunPipelineActivity (NonEmpty ByteString) Source #

The sample message payloads on which the pipeline activity is run.

Destructuring the Response

data RunPipelineActivityResponse Source #

See: newRunPipelineActivityResponse smart constructor.

Constructors

RunPipelineActivityResponse'
Fields logResult :: Maybe Text In case the pipeline activity fails, the log message that is generated. payloads :: Maybe (NonEmpty Base64) 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 :: Int The response's http status code.

Instances

Instances details

Eq RunPipelineActivityResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity Methods (==) :: RunPipelineActivityResponse -> RunPipelineActivityResponse -> Bool # (/=) :: RunPipelineActivityResponse -> RunPipelineActivityResponse -> Bool #
Read RunPipelineActivityResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity Methods readsPrec :: Int -> ReadS RunPipelineActivityResponse # readList :: ReadS [RunPipelineActivityResponse] # readPrec :: ReadPrec RunPipelineActivityResponse # readListPrec :: ReadPrec [RunPipelineActivityResponse] #
Show RunPipelineActivityResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity Methods showsPrec :: Int -> RunPipelineActivityResponse -> ShowS # show :: RunPipelineActivityResponse -> String # showList :: [RunPipelineActivityResponse] -> ShowS #
Generic RunPipelineActivityResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity Associated Types type Rep RunPipelineActivityResponse :: Type -> Type # Methods from :: RunPipelineActivityResponse -> Rep RunPipelineActivityResponse x # to :: Rep RunPipelineActivityResponse x -> RunPipelineActivityResponse #
NFData RunPipelineActivityResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity Methods rnf :: RunPipelineActivityResponse -> () #
type Rep RunPipelineActivityResponse Source #
Instance details Defined in Amazonka.IoTAnalytics.RunPipelineActivity type Rep RunPipelineActivityResponse = D1 ('MetaData "RunPipelineActivityResponse" "Amazonka.IoTAnalytics.RunPipelineActivity" "libZSservicesZSamazonka-iot-analyticsZSamazonka-iot-analytics" 'False) (C1 ('MetaCons "RunPipelineActivityResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "logResult") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "payloads") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Base64))) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newRunPipelineActivityResponse Source #

Arguments

:: Int	`$sel:httpStatus:RunPipelineActivityResponse'`
-> RunPipelineActivityResponse

Create a value of RunPipelineActivityResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:logResult:RunPipelineActivityResponse', runPipelineActivityResponse_logResult - In case the pipeline activity fails, the log message that is generated.

$sel:payloads:RunPipelineActivity', 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.)

$sel:httpStatus:RunPipelineActivityResponse', runPipelineActivityResponse_httpStatus - The response's http status code.

Response Lenses

runPipelineActivityResponse_logResult :: Lens' RunPipelineActivityResponse (Maybe Text) Source #

In case the pipeline activity fails, the log message that is generated.

runPipelineActivityResponse_payloads :: Lens' RunPipelineActivityResponse (Maybe (NonEmpty ByteString)) Source #

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_httpStatus :: Lens' RunPipelineActivityResponse Int Source #

The response's http status code.