pub struct StartFlowFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to StartFlow
.
Activates an existing flow. For on-demand flows, this operation runs the flow immediately. For schedule and event-triggered flows, this operation activates the flow.
Implementations§
source§impl StartFlowFluentBuilder
impl StartFlowFluentBuilder
sourcepub async fn send(self) -> Result<StartFlowOutput, SdkError<StartFlowError>>
pub async fn send(self) -> Result<StartFlowOutput, SdkError<StartFlowError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<StartFlow, AwsResponseRetryClassifier>, SdkError<StartFlowError>>
pub async fn customize( self ) -> Result<CustomizableOperation<StartFlow, AwsResponseRetryClassifier>, SdkError<StartFlowError>>
Consumes this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.
sourcepub fn flow_name(self, input: impl Into<String>) -> Self
pub fn flow_name(self, input: impl Into<String>) -> Self
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
sourcepub fn set_flow_name(self, input: Option<String>) -> Self
pub fn set_flow_name(self, input: Option<String>) -> Self
The specified name of the flow. Spaces are not allowed. Use underscores (_) or hyphens (-) only.
sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
The clientToken
parameter is an idempotency token. It ensures that your StartFlow
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 clientToken
parameter value.
If you omit a clientToken
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.
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 triggerConfig
parameter.
If you use a different value for clientToken
, Amazon AppFlow considers it a new call to StartFlow
. The token is active for 8 hours.
sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
The clientToken
parameter is an idempotency token. It ensures that your StartFlow
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 clientToken
parameter value.
If you omit a clientToken
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.
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 triggerConfig
parameter.
If you use a different value for clientToken
, Amazon AppFlow considers it a new call to StartFlow
. The token is active for 8 hours.
Trait Implementations§
source§impl Clone for StartFlowFluentBuilder
impl Clone for StartFlowFluentBuilder
source§fn clone(&self) -> StartFlowFluentBuilder
fn clone(&self) -> StartFlowFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more