aws_sdk_iotanalytics/client/
run_pipeline_activity.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`RunPipelineActivity`](crate::operation::run_pipeline_activity::builders::RunPipelineActivityFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`pipeline_activity(PipelineActivity)`](crate::operation::run_pipeline_activity::builders::RunPipelineActivityFluentBuilder::pipeline_activity) / [`set_pipeline_activity(Option<PipelineActivity>)`](crate::operation::run_pipeline_activity::builders::RunPipelineActivityFluentBuilder::set_pipeline_activity):<br>required: **true**<br><p>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.</p><br>
7    ///   - [`payloads(Blob)`](crate::operation::run_pipeline_activity::builders::RunPipelineActivityFluentBuilder::payloads) / [`set_payloads(Option<Vec::<Blob>>)`](crate::operation::run_pipeline_activity::builders::RunPipelineActivityFluentBuilder::set_payloads):<br>required: **true**<br><p>The sample message payloads on which the pipeline activity is run.</p><br>
8    /// - On success, responds with [`RunPipelineActivityOutput`](crate::operation::run_pipeline_activity::RunPipelineActivityOutput) with field(s):
9    ///   - [`payloads(Option<Vec::<Blob>>)`](crate::operation::run_pipeline_activity::RunPipelineActivityOutput::payloads): <p>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.)</p>
10    ///   - [`log_result(Option<String>)`](crate::operation::run_pipeline_activity::RunPipelineActivityOutput::log_result): <p>In case the pipeline activity fails, the log message that is generated.</p>
11    /// - On failure, responds with [`SdkError<RunPipelineActivityError>`](crate::operation::run_pipeline_activity::RunPipelineActivityError)
12    pub fn run_pipeline_activity(&self) -> crate::operation::run_pipeline_activity::builders::RunPipelineActivityFluentBuilder {
13        crate::operation::run_pipeline_activity::builders::RunPipelineActivityFluentBuilder::new(self.handle.clone())
14    }
15}