aws_sdk_appflow/client/
start_flow.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 [`StartFlow`](crate::operation::start_flow::builders::StartFlowFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`flow_name(impl Into<String>)`](crate::operation::start_flow::builders::StartFlowFluentBuilder::flow_name) / [`set_flow_name(Option<String>)`](crate::operation::start_flow::builders::StartFlowFluentBuilder::set_flow_name):<br>required: **true**<br><p>The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.</p><br>
7    ///   - [`client_token(impl Into<String>)`](crate::operation::start_flow::builders::StartFlowFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_flow::builders::StartFlowFluentBuilder::set_client_token):<br>required: **false**<br><p>The <code>clientToken</code> parameter is an idempotency token. It ensures that your <code>StartFlow</code> request completes only once. You choose the value to pass. For example, if you don't receive a response from your request, you can safely retry the request with the same <code>clientToken</code> parameter value.</p> <p>If you omit a <code>clientToken</code> value, the Amazon Web Services SDK that you are using inserts a value for you. This way, the SDK can safely retry requests multiple times after a network error. You must provide your own value for other use cases.</p> <p>If you specify input parameters that differ from your first request, an error occurs for flows that run on a schedule or based on an event. However, the error doesn't occur for flows that run on demand. You set the conditions that initiate your flow for the <code>triggerConfig</code> parameter.</p> <p>If you use a different value for <code>clientToken</code>, Amazon AppFlow considers it a new call to <code>StartFlow</code>. The token is active for 8 hours.</p><br>
8    /// - On success, responds with [`StartFlowOutput`](crate::operation::start_flow::StartFlowOutput) with field(s):
9    ///   - [`flow_arn(Option<String>)`](crate::operation::start_flow::StartFlowOutput::flow_arn): <p>The flow's Amazon Resource Name (ARN).</p>
10    ///   - [`flow_status(Option<FlowStatus>)`](crate::operation::start_flow::StartFlowOutput::flow_status): <p>Indicates the current status of the flow.</p>
11    ///   - [`execution_id(Option<String>)`](crate::operation::start_flow::StartFlowOutput::execution_id): <p>Returns the internal execution ID of an on-demand flow when the flow is started. For scheduled or event-triggered flows, this value is null.</p>
12    /// - On failure, responds with [`SdkError<StartFlowError>`](crate::operation::start_flow::StartFlowError)
13    pub fn start_flow(&self) -> crate::operation::start_flow::builders::StartFlowFluentBuilder {
14        crate::operation::start_flow::builders::StartFlowFluentBuilder::new(self.handle.clone())
15    }
16}
aws_sdk_appflow/client/start_flow.rs

aws_sdk_appflow/client/
start_flow.rs
